/syndicatedArticles

post https://api.newswhip.com/v1/syndicatedArticles

Sorting options

You can sort your results based on the following options. The sort order is always descending.

Option	Definition
`created_at`	The published date of the matched article.
`fb_total_engagement`	The total number of interactions (reactions, comments, shares) for the matched article on Facebook.
`fb_tw_overperforming`	The sum of Facebook and Twitter Overperforming scores,
`fb_tw_and_li`	The sum of Facebook, Twitter, and LinkedIn engagements. See Known issues for an update on availability of LinkedIn data.
`fb_tw_li_and_pi`	The sum of Facebook, Twitter, LinkedIn and Pinterest engagements. See Known issues for an update on availability of LinkedIn data.
`linkedin`	Equivalent to `li_count`, the total number of engagements the matched article has on LinkedIn. See Known issues for an update on availability of LinkedIn data.
`match_rate`	The percentage match of the matched article with the source article.
`nw_max_score`	The maximum social velocity of the matched article to date.
`nw_score`	The current social velocity of the matched article.
`predicted_interactions`	The total number engagements we predict that the story will achieve on Facebook and Twitter (combined).
`twitter`	Equivalent to `tw_count`, the total number of Influencer Shares the matched article has on Twitter.

Query Params

key

string

required

Your API key. The DevHub key will not work for this endpoint.

Body Params

from

int64

Defaults to null

Unix timestamp in milliseconds. Filters articles published after. This is based on the matched article. Defaults to a week ago.

int64

Defaults to null

Unix timestamp in milliseconds. Filters articles published before. This is based on the matched article. Defaults to now.

min_match_rate

int32

Defaults to 10

Set a minimum match_rate for results. Defaults to 10.

max_match_rate

int32

Defaults to 100

Set a maximum match_rate for results. Defaults to 100.

language

string

Defaults to Any

Two letter ISO 639-1 language code of the matched article. Defaults to any language.

sort_by

string

Defaults to The default sort_by is nw_max_score when the selected time-range is <= 25h, otherwise it will be fb_tw_and_li

See below for sorting options.

size

int32

The number of results to return in the response. Defaults to 200. The maximum you can specify is 5,000.

filters

array of strings

required

Filters that apply to the matched article. Additional parameters that can be used to refine the data that is returned, based on the matched content properties. If no field is defined but a search string is present, the API will search for the value in headline, summary, and authors. 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*

syndication_query

object

required

Filters that apply to the source article. See below for available fields. 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.

Responses

Sorting options

200200

400400