---
title: Query analytics summary
---
[Skip to content](#_top)
[API Reference](https://developers.cloudflare.com/api)
[Analytics Query](https://developers.cloudflare.com/api/resources/analytics_query)
Copy Markdown
Open in **Claude**Open in **ChatGPT**Open in **Cursor**
---
**Copy Markdown****View as Markdown**
# Query analytics summary
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.
##### Security
API Token
The preferred authorization scheme for interacting with the Cloudflare API. Create a token.
**Example:**Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY
API Email + API Key
The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.
**Example:**X-Auth-Email: user@example.com
The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.
**Example:**X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194
##### Accepted Permissions (at least one required)
`Zero Trust Read`
##### P ath ParametersExpand Collapse
account\_id: string
maxLength32
[Link to this property](<#(resource)%20analytics_query%20%3E%20(method)%20summary%20%3E%20(params)%20default%20%3E%20(param)%20account_id%20%3E%20(schema)>)
dataset: string
[Link to this property](<#(resource)%20analytics_query%20%3E%20(method)%20summary%20%3E%20(params)%20default%20%3E%20(param)%20dataset%20%3E%20(schema)>)
##### Body ParametersJSONExpand Collapse
filters: array of object {name, op, values }
Filters to apply before aggregating results.
name: string
Specifies the column name to filter on. Requires a valid column for the target dataset (e.g. country, allowed, appId).
Link to this property
op: string
Filter operator. Common values: eq, neq, in, not_in, gt, lt, gte, lte.
Link to this property
values: array of stringor booleanor number
Values to match against. Type depends on the column.
One of the following:
string
Link to this property
boolean
Link to this property
number
Link to this property
Link to this property
[Link to this property](<#(resource)%20analytics_query%20%3E%20(method)%20summary%20%3E%20(params)%200%20%3E%20(param)%20filters%20%3E%20(schema)>)
from: string
The start of the query time range (inclusive). RFC3339 format with timezone is required (e.g. `2024-11-05T00:00:00Z`).
formatdate-time
[Link to this property](<#(resource)%20analytics_query%20%3E%20(method)%20summary%20%3E%20(params)%200%20%3E%20(param)%20from%20%3E%20(schema)>)
groupBy: array of string
Specifies the column names to group results by. Requires valid columns for the target dataset.
[Link to this property](<#(resource)%20analytics_query%20%3E%20(method)%20summary%20%3E%20(params)%200%20%3E%20(param)%20groupBy%20%3E%20(schema)>)
stats: array of string
Specifies the stat names to include in results. Requires valid stats for the target dataset (e.g. `attemptsTotal`, `bytesTotal`).
[Link to this property](<#(resource)%20analytics_query%20%3E%20(method)%20summary%20%3E%20(params)%200%20%3E%20(param)%20stats%20%3E%20(schema)>)
to: string
Specifies the end of the query time range (exclusive). Requires RFC3339 format with timezone.
formatdate-time
[Link to this property](<#(resource)%20analytics_query%20%3E%20(method)%20summary%20%3E%20(params)%200%20%3E%20(param)%20to%20%3E%20(schema)>)
##### ReturnsExpand Collapse
errors: array of object {code, message }
code: optional number
Link to this property
message: optional string
Link to this property
[Link to this property](<#(resource)%20analytics_query%20%3E%20(method)%20summary%20%3E%20(network%20schema)%20%3E%20(property)%20errors>)
messages: array of object {code, message }
code: optional number
Link to this property
message: optional string
Link to this property
[Link to this property](<#(resource)%20analytics_query%20%3E%20(method)%20summary%20%3E%20(network%20schema)%20%3E%20(property)%20messages>)
result: object {currentTotal, previousTotal }
currentTotal: array of map\[unknown]
Aggregated stats for the requested time range.
Link to this property
previousTotal: array of map\[unknown]
Aggregated stats for the equivalent preceding time range, for trend comparison.
Link to this property
[Link to this property](<#(resource)%20analytics_query%20%3E%20(method)%20summary%20%3E%20(network%20schema)%20%3E%20(property)%20result>)
success: boolean
[Link to this property](<#(resource)%20analytics_query%20%3E%20(method)%20summary%20%3E%20(network%20schema)%20%3E%20(property)%20success>)
### Query analytics summary
HTTP
HTTPTypeScriptPythonGoTerraform
```
curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/analytics/query/$DATASET/summary \
-H 'Content-Type: application/json' \
-H "Authorization: Bearer $CLOUDFLARE_API_TOKEN" \
-d '{
"filters": [
{
"name": "country",
"op": "in",
"values": [
"US",
"CA",
"GB"
]
}
],
"from": "2024-11-01T00:00:00Z",
"groupBy": [
"string"
],
"stats": [
"attemptsTotal"
],
"to": "2024-11-08T00:00:00Z"
}'
```
200 example
400 example
400 example
403 example
403 example
```
{
"errors": [],
"messages": [
{
"code": 1000,
"message": "API in beta: expect breaking changes."
}
],
"result": {
"currentTotal": [
{
"attemptsTotal": 48291
}
],
"previousTotal": [
{
"attemptsTotal": 41033
}
]
},
"success": true
}
```
```
{
"errors": [
{
"code": 11005,
"message": "art.api.parameter.invalid"
}
],
"messages": [
{
"code": 1002,
"message": "Parameter 'from' has invalid value '2024-11-05 00:00:00'. Should be of type: 'RFC3339'"
}
],
"result": null,
"success": false
}
```
```
{
"errors": [
{
"code": 11005,
"message": "art.api.parameter.invalid"
}
],
"messages": [
{
"code": 1000,
"message": "API in beta: expect breaking changes."
}
],
"result": null,
"success": false
}
```
```
{
"errors": [
{
"code": 11003,
"message": "art.api.resource.insufficient_permissions"
}
],
"messages": [
{
"code": 1000,
"message": "API in beta: expect breaking changes."
}
],
"result": null,
"success": false
}
```
```
{
"errors": [
{
"code": 11003,
"message": "art.api.resource.insufficient_permissions"
}
],
"messages": [],
"result": null,
"success": false
}
```
##### Returns Examples
200 example
400 example
400 example
403 example
403 example
```
{
"errors": [],
"messages": [
{
"code": 1000,
"message": "API in beta: expect breaking changes."
}
],
"result": {
"currentTotal": [
{
"attemptsTotal": 48291
}
],
"previousTotal": [
{
"attemptsTotal": 41033
}
]
},
"success": true
}
```
```
{
"errors": [
{
"code": 11005,
"message": "art.api.parameter.invalid"
}
],
"messages": [
{
"code": 1002,
"message": "Parameter 'from' has invalid value '2024-11-05 00:00:00'. Should be of type: 'RFC3339'"
}
],
"result": null,
"success": false
}
```
```
{
"errors": [
{
"code": 11005,
"message": "art.api.parameter.invalid"
}
],
"messages": [
{
"code": 1000,
"message": "API in beta: expect breaking changes."
}
],
"result": null,
"success": false
}
```
```
{
"errors": [
{
"code": 11003,
"message": "art.api.resource.insufficient_permissions"
}
],
"messages": [
{
"code": 1000,
"message": "API in beta: expect breaking changes."
}
],
"result": null,
"success": false
}
```
```
{
"errors": [
{
"code": 11003,
"message": "art.api.resource.insufficient_permissions"
}
],
"messages": [],
"result": null,
"success": false
}
```