Get the emotions

GET 
/emotions

Returns the emotions.

Cost: 1 credit per call.

Request

Query Parameters

startDate date-time
Possible values: Value must match regular expression ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,6})?(Z|\+00:00)$
The start date, used to filter results. It must respect RFC3339 format, UTC date-time without timezone. Examples : "1977-04-22T07:00:00.000Z", "1977-04-22T07:00:00.000+00:00".
Note : the start date is inclusive, meaning that the results will include the start date.
Limitations:
• Default: the API returns the results for the last hour by default.
• Maximum: the API can go back in time up to 15 days. If an older date is provided, the API will limit its results to 15 days.
Example: 1977-04-22T06:00:00.000Z
endDate date-time
Possible values: Value must match regular expression ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,6})?(Z|\+00:00)$
The end date, used to filter results. It must respect RFC3339 format, UTC date-time without timezone. Examples : "1977-04-22T07:00:00.000Z", "1977-04-22T07:00:00.000+00:00".
Note : the end date is exclusive, meaning that the results will not include the end date.
Limitations:
• The endDate must be greater than the startDate, otherwise the API returns an error.
Example: 1977-04-22T07:00:00.000Z
categoryId int32

Possible values: >= 1 and <= 2147483647

The category's id, used to filter the results.

sourceType string

Possible values: [news, social]

The source type, used to filter the results.

domainName hostname
Possible values: Value must match regular expression ^[a-z][0-9a-z.-]{0,100}\.[a-z]{2,4}$
The domain name, used to filter the results.
Example: example.com
language languageModel
Possible values: [aa, ab, ae, af, ak, am, an, ar, as, av, ay, az, ba, be, bg, bh, bi, bm, bn, bo, br, bs, ca, ce, ch, co, cr, cs, cu, cv, cy, da, de, dv, dz, ee, el, en, eo, es, et, eu, fa, ff, fi, fj, fo, fr, fy, ga, gd, gl, gn, gu, gv, ha, he, hi, ho, hr, ht, hu, hy, hz, ia, id, ie, ig, ii, ik, io, is, it, iu, ja, jv, ka, kg, ki, kj, kk, kl, km, kn, ko, kr, ks, ku, kv, kw, ky, la, lb, lg, li, ln, lo, lt, lu, lv, mg, mh, mi, mk, ml, mn, mr, ms, mt, my, na, nb, nd, ne, ng, nl, nn, no, nr, nv, ny, oc, oj, om, or, os, pa, pi, pl, ps, pt, qu, rm, rn, ro, ru, rw, sa, sc, sd, se, sg, si, sk, sl, sm, sn, so, sq, sr, ss, st, su, sv, sw, ta, te, tg, th, ti, tk, tl, tn, to, tr, ts, tt, tw, ty, ug, uk, ur, uz, ve, vi, vo, wa, wo, xh, yi, yo, za, zh, zu]
The ISO 639-1 language tag, used to filter the results.
Example: fr
keywords string[]
Possible values: >= 1, <= 5
A list of keywords used to filter the posts. Depends on keywords condition (or/and) to filter the posts.
This parameter is case-insensitive.
Example: [btc, bitcoin]
keywordsCondition string

Possible values: [and, or]

Default value: and

The condition to return the posts that match one or all of the keywords passed in input.

Header Parameters

X-Exorde-Api-Version stringrequired

Possible values: [v1]

The API version.

Responses

200

OK

application/json

Schema

Schema

emotion objectrequired

The repartition of Emotion in a dataset of Posts.

emotions objectnullablerequired

love int32required

The number of occurrences of love emotion for the query.

admiration int32required

The number of occurrences of admiration emotion for the query.

joy int32required

The number of occurrences of joy emotion for the query.

approval int32required

The number of occurrences of approval emotion for the query.

caring int32required

The number of occurrences of caring emotion for the query.

excitement int32required

The number of occurrences of excitement emotion for the query.

gratitude int32required

The number of occurrences of gratitude emotion for the query.

desire int32required

The number of occurrences of desire emotion for the query.

anger int32required

The number of occurrences of anger emotion for the query.

optimism int32required

The number of occurrences of optimism emotion for the query.

disapproval int32required

The number of occurrences of disapproval emotion for the query.

grief int32required

The number of occurrences of grief emotion for the query.

annoyance int32required

The number of occurrences of annoyance emotion for the query.

pride int32required

The number of occurrences of pride emotion for the query.

curiosity int32required

The number of occurrences of curiosity emotion for the query.

neutral int32required

The number of occurrences of neutral emotion for the query.

disgust int32required

The number of occurrences of disgust emotion for the query.

disappointment int32required

The number of occurrences of disappointment emotion for the query.

realization int32required

The number of occurrences of realization emotion for the query.

fear int32required

The number of occurrences of fear emotion for the query.

relief int32required

The number of occurrences of relief emotion for the query.

confusion int32required

The number of occurrences of confusion emotion for the query.

remorse int32required

The number of occurrences of remorse emotion for the query.

embarrassment int32required

The number of occurrences of embarrassment emotion for the query.

surprise int32required

The number of occurrences of surprise emotion for the query.

sadness int32required

The number of occurrences of sadness emotion for the query.

nervousness int32required

The number of occurrences of nervousness emotion for the query.

postsCount int32required

The number of posts found for the query.

startDate date-timerequired

The lower bound date of data used to calculate the emotion. It respect RFC3339 format, UTC date-time without timezone.

endDate date-timerequired

The upper bound date of data used to calculate the emotion. It respect RFC3339 format, UTC date-time without timezone.

status objectrequired

cost int32required

Number of credits that were consumed for this request.

apiDeprecationNotice object

Deprecation notice of the API.

message stringrequired

A message that tells when the API version will be shut down.

shutdownDate date-timerequired

The date of removal of the API version, UTC date-time without timezone using RFC3339 format.

Example (from schema)

{
  "emotion": {
    "emotions": {
      "love": 0,
      "admiration": 0,
      "joy": 0,
      "approval": 0,
      "caring": 0,
      "excitement": 0,
      "gratitude": 0,
      "desire": 0,
      "anger": 0,
      "optimism": 0,
      "disapproval": 0,
      "grief": 0,
      "annoyance": 0,
      "pride": 0,
      "curiosity": 0,
      "neutral": 0,
      "disgust": 0,
      "disappointment": 0,
      "realization": 0,
      "fear": 0,
      "relief": 0,
      "confusion": 0,
      "remorse": 0,
      "embarrassment": 0,
      "surprise": 0,
      "sadness": 0,
      "nervousness": 0
    },
    "postsCount": 0,
    "startDate": "1977-04-22T07:00:00.000Z",
    "endDate": "1977-04-22T07:00:00.000Z"
  },
  "status": {
    "cost": 0,
    "apiDeprecationNotice": {
      "message": "The version 1 of the API is deprecated and will be shut down the 2022-02-02 at 00:00:00 UTC.",
      "shutdownDate": "2022-02-02T00:00:00.000Z"
    }
  }
}

400

Bad Request

application/json

Schema

Schema

error objectrequired

message stringrequired

The description of the error. It gives meaningful information about what happened.

code integerrequired

Possible values: >= 100 and <= 600

The error code. Please use our documentation to get more information about it.

userId uuid

Possible values: Value must match regular expression ^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}$

The id of the user that made the request.

requestId uuid

Possible values: Value must match regular expression ^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}$

The id of the request.

status objectrequired

cost int32required

Number of credits that were consumed for this request.

apiDeprecationNotice object

Deprecation notice of the API.

message stringrequired

A message that tells when the API version will be shut down.

shutdownDate date-timerequired

The date of removal of the API version, UTC date-time without timezone using RFC3339 format.

Example (from schema)

{
  "error": {
    "message": "An error occurred.",
    "code": 0,
    "userId": "123e4567-e89b-12d3-a456-426655440000",
    "requestId": "123e4567-e89b-12d3-a456-426655440000"
  },
  "status": {
    "cost": 0,
    "apiDeprecationNotice": {
      "message": "The version 1 of the API is deprecated and will be shut down the 2022-02-02 at 00:00:00 UTC.",
      "shutdownDate": "2022-02-02T00:00:00.000Z"
    }
  }
}

401

Unauthorized

application/json

Schema

Schema

error objectrequired

message stringrequired

The description of the error. It gives meaningful information about what happened.

code integerrequired

Possible values: >= 100 and <= 600

The error code. Please use our documentation to get more information about it.

userId uuid

Possible values: Value must match regular expression ^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}$

The id of the user that made the request.

requestId uuid

Possible values: Value must match regular expression ^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}$

The id of the request.

status objectrequired

cost int32required

Number of credits that were consumed for this request.

apiDeprecationNotice object

Deprecation notice of the API.

message stringrequired

A message that tells when the API version will be shut down.

shutdownDate date-timerequired

The date of removal of the API version, UTC date-time without timezone using RFC3339 format.

Example (from schema)

{
  "error": {
    "message": "An error occurred.",
    "code": 0,
    "userId": "123e4567-e89b-12d3-a456-426655440000",
    "requestId": "123e4567-e89b-12d3-a456-426655440000"
  },
  "status": {
    "cost": 0,
    "apiDeprecationNotice": {
      "message": "The version 1 of the API is deprecated and will be shut down the 2022-02-02 at 00:00:00 UTC.",
      "shutdownDate": "2022-02-02T00:00:00.000Z"
    }
  }
}

403

Forbidden

application/json

Schema

Schema

error objectrequired

message stringrequired

The description of the error. It gives meaningful information about what happened.

code integerrequired

Possible values: >= 100 and <= 600

The error code. Please use our documentation to get more information about it.

userId uuid

Possible values: Value must match regular expression ^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}$

The id of the user that made the request.

requestId uuid

Possible values: Value must match regular expression ^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}$

The id of the request.

status objectrequired

cost int32required

Number of credits that were consumed for this request.

apiDeprecationNotice object

Deprecation notice of the API.

message stringrequired

A message that tells when the API version will be shut down.

shutdownDate date-timerequired

The date of removal of the API version, UTC date-time without timezone using RFC3339 format.

Example (from schema)

{
  "error": {
    "message": "An error occurred.",
    "code": 0,
    "userId": "123e4567-e89b-12d3-a456-426655440000",
    "requestId": "123e4567-e89b-12d3-a456-426655440000"
  },
  "status": {
    "cost": 0,
    "apiDeprecationNotice": {
      "message": "The version 1 of the API is deprecated and will be shut down the 2022-02-02 at 00:00:00 UTC.",
      "shutdownDate": "2022-02-02T00:00:00.000Z"
    }
  }
}

429

Too Many Requests

application/json

Schema

Schema

error objectrequired

message stringrequired

The description of the error. It gives meaningful information about what happened.

code integerrequired

Possible values: >= 100 and <= 600

The error code. Please use our documentation to get more information about it.

userId uuid

Possible values: Value must match regular expression ^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}$

The id of the user that made the request.

requestId uuid

Possible values: Value must match regular expression ^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}$

The id of the request.

status objectrequired

cost int32required

Number of credits that were consumed for this request.

apiDeprecationNotice object

Deprecation notice of the API.

message stringrequired

A message that tells when the API version will be shut down.

shutdownDate date-timerequired

The date of removal of the API version, UTC date-time without timezone using RFC3339 format.

Example (from schema)

{
  "error": {
    "message": "An error occurred.",
    "code": 0,
    "userId": "123e4567-e89b-12d3-a456-426655440000",
    "requestId": "123e4567-e89b-12d3-a456-426655440000"
  },
  "status": {
    "cost": 0,
    "apiDeprecationNotice": {
      "message": "The version 1 of the API is deprecated and will be shut down the 2022-02-02 at 00:00:00 UTC.",
      "shutdownDate": "2022-02-02T00:00:00.000Z"
    }
  }
}

500

Internal Server Error

application/json

Schema

Schema

requestId uuid

Possible values: Value must match regular expression ^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}$

The id of the request.

Example (from schema)

{
  "requestId": "123e4567-e89b-12d3-a456-426655440000"
}

503

Service Unavailable

Loading...