POST /3/patterns/timeseries

Returns one time series per groupBy combination, each with period totals and a per-day metric breakdown. metrics and parameters are required; groupBy and filters are optional. Discover valid field kinds per domain with /3/patterns/fields.

Servers

https://analytics.{region}.algolia.com
https://analytics.algolia.com

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Query parameters

Name	Type	Required	Description
`index`	String	No	Comma-separated list of indices the request runs on, used for authorization. Required for index-restricted API keys and must match the indices supplied in the request body's `indices` parameter; optional for unrestricted keys.

Request body fields

Name	Type	Required	Description
`metrics[]`	Array	Yes	Fields to aggregate.
`metrics[].domain`	String	No	Domain the field belongs to. Defaults to the payload's top-level `domain` when omitted.
`metrics[].kind`	String	Yes	Field identifier within the domain, as listed by the `/3/patterns/fields` catalog.
`filters[]`	Array	No	Filter conditions.
`filters[].parameter`	Object	No
`filters[].parameter.domain`	String	No	Domain the parameter belongs to.
`filters[].parameter.kind`	String	Yes	Parameter identifier that resolves to a value supplied in `parameters`.
`filters[].operator`	String	No	Comparison operator applied to a filter field, one of: `=`, `!=`, `>`, `<`, `>=`, `<=`, `IN`, `TAG_TREE`, `CONTAINS`, `STARTS_WITH`, `CONTAINS_PREFIX`. Requires a `parameter` to carry the operand.
`filters[].domain`	String	No	Domain the field belongs to.
`filters[].kind`	String	Yes	Field to filter on. With no `operator`, the field must be boolean.
`limit`	Integer	No	Maximum number of series (groupBy values) to return. Default value: 100
`groupBy[]`	Array	No	Fields to split the series by.
`groupBy[].domain`	String	No	Domain the field belongs to. Defaults to the payload's top-level `domain` when omitted.
`groupBy[].kind`	String	Yes	Field identifier within the domain, as listed by the `/3/patterns/fields` catalog.
`parameters[]`	Array	Yes	Literal values referenced by the query.
`parameters[].domain`	String	No	Domain the parameter belongs to.
`parameters[].value`		Yes	Literal value. Its JSON type depends on `kind` (array of strings for `indices`, string for dates, tags, and country, number for numeric operands, and so on).
`parameters[].kind`	String	Yes	Parameter identifier, for example `indices`, `startDate`, `endDate`, `tags`, or `country`.
`domain`	String	No	Default domain propagated to entries that omit their own.
`offset`	Integer	No	Number of series to skip. Default value: 0

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.