/articles

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

To use this endpoint you will need the following reference data:

📘

Time range

The maximum range between the from and to dates in your query should not exceed 7 days.

📘

Naming differences

For historical reasons, the queryable fields headline and summary differ in naming from their Article counterparts link and excerpt.

Filters

The following filtering options can be used in the filters body parameter.

FieldTypeDescription
headlineString
summaryString
authorsString
country_codeStringTwo letter (lower case) ISO 3166 country code.
region_codeStringAvailable regions (lower case):
  • na North America
  • eu Europe
  • oc Oceania
  • sea South East Asia
  • sa South America
  • as Asia
  • me Middle East
  • af Africa
languageStringSupported languages are listed in Supported Languages.
categoriesNumberSupported categories are listed in Topics.
publisherStringTLD such as newswhip.com.
domainStringExact domain where the article was published. e.g. blog.newswhip.com.
domainsStringThe possible permutations of publisher and subdomains. See this section of the data dictionary for an explanation of the difference between publisher, domain, and domains.
hrefStringSearch by the full url of the article eg. "href:\"https://www.coldwellbankerhomes.com/az/concho/669-county-road-8235-stanford/pid_18337473/\""
siteStructureHandy for articles that follows a particular path on a site, e.g: to look for all articles with url follows "http://www.complex.com/tag/politics", use filter with publisher:complex.com AND siteStructure:\\/tags\\/politics or publisher:complex.com AND siteStructure:"/tags/politics" will be sufficient.

Sort By

For all content types or the stories content type

Sorts 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

When 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.
Query Params
string
required
Defaults to DevHub

Your API key.

Body Params
filters
array of strings
required

See the Notes section at the bottom of this page. The Lucene query strings section shares important considerations, including the limits to the number of filters that are allowed.

filters*
int64
Defaults to null

Unix timestamp in milliseconds. Filters articles published after {from}. Defaults to a week ago.

int64
Defaults to null

Unix timestamp in milliseconds. Filters articles published before {to}. Defaults to now.

string
Defaults to en

Two letter ISO 639-1 language code. Defaults to any language.

string
Defaults to default

See notes below.

boolean
Defaults to false

Ignored when searching by the content_type youtube. Defaults to false.

default_fields
array of strings
Defaults to headline,summary,authors

Up to 3 available fields to be used filtering only by keywords (like "Barack Obama"). Defaults to headline, summary, and authors.

default_fields
int32
Defaults to 5

Max number of articles to be returned (includes relatedStories). Defaults to 200. The maximum you can specify is 5,000.

boolean
Defaults to true
string

Filter by stories or youtube. Defaults to stories.

boolean
Defaults to false

If you want to search the full article text, set this to true. Defaults to false.

Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json