To use this endpoint you will need the following reference data:
Time rangeThe maximum range between the
fromandtodates in your query should not exceed 7 days.
Naming differencesFor historical reasons, the queryable fields
headlineandsummarydiffer in naming from theirArticlecounterpartslinkandexcerpt.
Filters
The following filtering options can be used in the filters body parameter.
Field | Type | Description |
|---|---|---|
| String | |
| String | |
| String | |
| String | Two letter (lower case) ISO 3166 country code. |
| String | Available regions (lower case):
|
| String | Supported languages are listed in Supported Languages. |
| Number | Supported categories are listed in Topics. |
| String | TLD such as |
| String | Exact domain where the article was published. e.g. |
| String | The possible permutations of publisher and subdomains. See this section of the data dictionary for an explanation of the difference between |
| String | Search by the full url of the article eg. |
| Handy for articles that follows a particular path on a site, e.g: to look for all articles with url follows |
Sort By
For all content types or the stories content type
stories content typeSorts one of the following in descending order:
defaultfb_total_engagementfb_tw_overperformingfb_overperformingtw_overperformingpredicted_interactionstwitterlinkedinfb_tw_and_lifb_tw_li_and_pinw_max_scorecreated_at
The default sort_by is nw_max_score when the selected time range is <= 25h, otherwise it will be fb_tw_overperforming.
For the youtube content type
youtube content typeWhen the content_type is set to youtube, the default sort order is by created_at. You can also sort in descending order by
yt_likesyt_viewsyt_commentscreated_at.