Skip to main content

Get the history of posts count

GET 
/volume/history

Returns the history of post counts, the response is a time series.

History data points are sorted by creation date, from the oldest to the newest.

Cost: 5 credits 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, the bucket containing it is always included in the response. The actual start date is aligned with the beginning of the time bucket containing it. The response may include data from before the requested 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 endDate is exclusive, the bucket containing it is never included in the response. The actual endDate is aligned with the end of the previous time bucket.

    Limitations:

    • The endDate must be greater than the startDate, otherwise the API returns an error.
    Example: 1977-04-22T07:00:00.000Z
    interval any

    The interval between data points in minutes. The interval must be a multiple of five minutes. Data are aggregated by interval and the average value of this interval is calculated and returned.

    You can specify the interval in minutes or in a human-readable format. The human-readable format is a number followed by a time unit. The supported time units are: m (minutes), h (hours), d (days), w (weeks), M (months), y (years).

    Minimum value is 5 minutes. Default value is 1h. Maximum value is 10 years.

    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.-]{1,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.

    paginationCursor string

    An opaque string representing the pagination cursor.

    limit int32

    Possible values: >= 1 and <= 1000

    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​

OK

Schema
    items object[]required

    Possible values: <= 1000

    An array of Volume ressources.

  • Array [
    • postsCount int32required

    The number of posts found for the query.

    startDate date-timerequired

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

    endDate date-timerequired

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

  • ]
    • requestedInterval int32

    Possible values: >= 5 and <= 5256000

    The requested interval between data points.

    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