Skip to main content

List posts

GET 
/posts

Returns all posts matching the filters.

Posts are sorted by creation date, from the newest to the oldest.

By default, the response only contains fields marked as required and fields used to filter the results. The other fields must be requested with the parameter additionalFields.

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.

    It should not be used with topicId, if the category in the request does not match the topics's category, there will be no result.

    topicId int32

    Possible values: >= 1 and <= 2147483647

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

    It should not be used with categoryId, if the category in the request does not match the topics's category, there will be no result.

    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.

    additionalFields string[]

    Possible values: [all, analysis, author, summary, domainName, externalParentId, externalId, language, image, analysis.emotions, analysis.sentiment, analysis.keywords, analysis.sourceType], >= 1, <= 13

    Optional fields to add in the response object.

    Notes:

    • There are two meta fields, all to request all fields and analysis to request all analysis fields.
    • If an optional field is in request's filters, it will be automatically added in the response.
    Example: [language, analysis.emotions]
    paginationCursor string

    An opaque string representing the pagination cursor.

    limit int32

    Possible values: >= 1 and <= 100

    Default value: 10

    The maximum number of objects returned per page.

Header Parameters

    X-Exorde-Api-Version stringrequired

    Possible values: [v1]

    The API version.

Responses​

Expected response to a valid request

Schema
    items object[]required

    Possible values: <= 100

    An array of Post ressources.

  • Array [
    • url urirequired

    The post URL.

    title stringnullablerequired

    The post title.

    createdAt date-timerequired

    The post creation date. It respect RFC3339 format, UTC date-time without timezone.

    topics uri[]required

    Links to the topics extracted from the content.

    categories uri[]required

    Links to the categories extracted from the content.

    summary stringnullable

    The post summary.

    author stringnullable

    The SHA1 of author's username.

    domainName string

    The domain name.

    externalParentId stringnullable

    The external id of the parent (in the source platform).

    externalId stringnullable

    The external id (in the source platform).

    image urinullable

    The url of the post image.

    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 language of the post, with its ISO 639-1 language tag.

    analysis object

    The post analysis.

    emotions object

    The emotions detected with their confidence index. The higher the confidence index, the more likely the emotion is to be in the post. A threshold of 0.5 can be applied to the probabilities for the prediction for each emotion.

    admiration float

    Possible values: <= 1

    anger float

    Possible values: <= 1

    annoyance float

    Possible values: <= 1

    approval float

    Possible values: <= 1

    caring float

    Possible values: <= 1

    confusion float

    Possible values: <= 1

    curiosity float

    Possible values: <= 1

    desire float

    Possible values: <= 1

    disappointment float

    Possible values: <= 1

    disapproval float

    Possible values: <= 1

    disgust float

    Possible values: <= 1

    embarrassment float

    Possible values: <= 1

    excitement float

    Possible values: <= 1

    fear float

    Possible values: <= 1

    gratitude float

    Possible values: <= 1

    grief float

    Possible values: <= 1

    joy float

    Possible values: <= 1

    love float

    Possible values: <= 1

    nervousness float

    Possible values: <= 1

    neutral float

    Possible values: <= 1

    optimism float

    Possible values: <= 1

    pride float

    Possible values: <= 1

    realization float

    Possible values: <= 1

    relief float

    Possible values: <= 1

    remorse float

    Possible values: <= 1

    sadness float

    Possible values: <= 1

    surprise float

    Possible values: <= 1

    sentiment float

    Possible values: >= -1 and <= 1

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

    keywords string[]

    The keywords extracted from the content.

    sourceType stringnullable

    Possible values: [news, social]

    The source type of the post.

  • ]
    • pagination object
    self uri

    Pagination link|cursor pointing to the current page.

    prev uri

    Pagination link|cursor pointing to the previous page.

    This link is not present if there is no previous page.

    next uri

    Pagination link|cursor pointing to the next page.

    This link is not present if there is no next page.

    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