Skip to main content

Get the sentiment

GET 
/sentiment

Returns the computed sentiment.

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​

OK

Schema
    sentiment objectrequired

    The computed Sentiment for a query.

    percentagePositivePosts floatnullablerequired

    Possible values: <= 100

    The percentage of positive posts.

    percentageNegativePosts floatnullablerequired

    Possible values: <= 100

    The percentage of negative posts.

    percentageNeutralPosts floatnullablerequired

    Possible values: <= 100

    The percentage of neutral posts.

    sentiment floatnullablerequired

    Possible values: >= -1 and <= 1

    The average sentiment of the posts. -1 is highly negative, 0 is neutral and +1 is highly positive.

    postsCount int32required

    The number of posts found for the query.

    startDate date-timerequired

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

    endDate date-timerequired

    The upper bound date of data used to calculate the sentiment. 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.

Loading...
Last updated on