To use this endpoint you will need the following reference data:
Time range
The maximum range between the
from
andto
dates in your query should not exceed 7 days.
Naming differences
For historical reasons, the queryable fields
headline
andsummary
differ in naming from theirArticle
counterpartslink
andexcerpt
.
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:
default
fb_total_engagement
fb_tw_overperforming
fb_overperforming
tw_overperforming
predicted_interactions
twitter
linkedin
fb_tw_and_li
fb_tw_li_and_pi
nw_max_score
created_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_likes
yt_views
yt_comments
created_at
.