/stats

post

https://api.newswhip.com/v1/stats

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

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

Filtering

You can filter for any option that is available for the /articles endpoint.

Aggregation

The Data dictionary provides notes on how publisher, domain, and domains are populated with data. Please read v1/stats aggregation options to make a decision on which is an appropriate aggregation option for your use case.

total_matched_articles field

On 6th May 2021 we included a new field in the response for this endpoint – “total_matched_articles”. This value represents the sum of all articles that match the filters for that aggregation group.

Query Params

key

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*

from

int64

Defaults to null

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

int64

Defaults to null

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

language

string

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

sort_by

string

required

Can sort using the following fields: fb_total, twitter, pinterest, linkedin. You can use the following values count, min, max, avg, sum, sum_of_squares, variance, std_deviation. For example, fb_total.sum or pinterest.max.

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

size

int32

Defaults to 200

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

aggregate_by

string

required

One of (“publisher”, “domains”, “domain”, “language”, “authors”, “categories”, “country_code”). See below for information about these options.

Time range

Filtering

Aggregation

total_matched_articles field

200200

400400