POST /accounts/{account_id}/analytics/query/{dataset}/summary

Returns aggregate summary stats for a dataset. Includes current-period and previous-period totals for trend comparison.

Servers

https://api.cloudflare.com/client/v4

Path parameters

Name	Type	Required	Description
`dataset`	String	Yes	Dataset name to query. Examples: `access-logins`, `gateway-http`, `gateway-dns`, `gateway-http`, `shadow-it`.
`account_id`	String	Yes	Cloudflare account identifier.

Request headers

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

Request body fields

Name	Type	Required	Description
`filters[]`	Array	Yes	Filters to apply before aggregating results.
`filters[].values[]`	Array	Yes	Values to match against. Type depends on the column.
`filters[].name`	String	Yes	Specifies the column name to filter on. Requires a valid column for the target dataset (e.g. `country`, `allowed`, `appId`).
`filters[].op`	String	Yes	Filter operator. Common values: `eq`, `neq`, `in`, `not_in`, `gt`, `lt`, `gte`, `lte`.
`to`	String	Yes	Specifies the end of the query time range (exclusive). Requires RFC3339 format with timezone.
`groupBy[]`	Array	Yes	Specifies the column names to group results by. Requires valid columns for the target dataset.
`stats[]`	Array	Yes	Specifies the stat names to include in results. Requires valid stats for the target dataset (e.g. `attemptsTotal`, `bytesTotal`).
`from`	String	Yes	The start of the query time range (inclusive). RFC3339 format with timezone is required (e.g. `2024-11-05T00:00:00Z`).

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.