POST
/
api
/
aggregation_count
Get aggregation count by interval
curl --request POST \
  --url https://v3-api.newscatcherapi.com/api/aggregation_count \
  --header 'Content-Type: application/json' \
  --header 'x-api-token: <api-key>' \
  --data '{
  "q": "renewable energy",
  "predefined_sources": "top 50 US",
  "from_": "2024/01/01",
  "to_": "2024/06/30",
  "aggregation_by": "day"
}'
{
  "status": "<string>",
  "total_hits": 123,
  "page": 123,
  "total_pages": 123,
  "page_size": 123,
  "aggregations": {
    "aggregation_count": [
      {
        "time_frame": "2024-12-31 00:00:00",
        "article_count": 86
      }
    ]
  },
  "user_input": {}
}

Authorizations

​
x-api-token
string
header
required

API Key to authenticate requests.

To access the API, include your API key in the x-api-token header. To obtain your API key, complete the form or contact us directly.

Body

application/json

Request body for aggregation counts based on specified criteria such as keyword, language, country, source, and more.

The body is of type object.

Response

A successful response containing aggregation count results that match the search criteria. If no matches, returns a failed aggregation response according to the defined schema.

The response model for a successful Aggregation count request. Response field behavior:

  • Required fields are guaranteed to be present and non-null.
  • Optional fields may be null or undefined if the data point is not presented or couldn't be extracted during processing.

The base response model containing common fields for search operations.