Aggregate Term (deprecated)

post deprecated

https://api.platform.datastreamer.io/api/aggregate/term

Deprecated. Use POST /api/search with a terms definition in query.aggregations. Search aggregations require private data sources.
Documentation: Aggregations with Search API
Term Aggregate endpoint enables the user to query the aggregated result based on the provided parameters. This retrieves counts for the desired field of the results against the query. Mostly used to generate dashboards, reports, and graphs.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

keep_alive_seconds

int32

30 to 300

This parameter creates and caches a pointer to the results of the query for the specified duration (in seconds) specified. This pointer prevents new data from entering the results of the query containing duplicates or gaps in paging. It also has the effect of improving performance while paging through query results.

Body Params

The term aggregate request containing the query and aggregation parameters.

continuation_token

object

Used to indicate that the request should be long lived.

keep_alive_seconds

int32 | null

Set keep_alive_seconds as a query parameter on the endpoint. The endpoint overwrites this body field with the query parameter.

query

string

required

length ≥ 1

A plain Apache Lucene query string, for example *. A nested query object is rejected.

field

string

required

length ≥ 1

Field to aggregate on, without the .keyword suffix. The field must be in the server-configured allowed terms fields list.

data_sources

array of strings

required

Required. The sources to search, using Auto source names such as twitter_auto. Use the private. prefix for private data, for example private.twitter_auto. A name the API key cannot access returns 403 with Cannot view data source.

data_sources*

Headers

apikey

string

API key for authentication.

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

401

Unauthorized. The apikey header is missing or invalid.

200Success

400Bad Request

403Forbidden. A requested data source cannot be viewed with this API key (JSON error), or the API key lacks Search feature permission (empty body).

500Server Error