reports
Creates, updates, deletes, gets or lists a reports resource.
Overview
| Name | reports |
| Type | Resource |
| Id | cloudflare.dns.reports |
Fields
The following fields are returned by SELECT queries:
- list
Table response
| Name | Datatype | Description |
|---|---|---|
dimensions | array | Array of dimension values, representing the combination of dimension values corresponding to this row. |
metrics | array | Array with one item per requested metric. Each item is a single value. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list | select | zone_id | metrics, dimensions, since, until, limit, sort, filters | Retrieves a list of summarised aggregate metrics over a given time period. See Analytics API properties for detailed information about the available query parameters. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
zone_id | string | The Cloudflare zone ID. |
dimensions | string | |
filters | string | |
limit | integer | |
metrics | string | |
since | string (date-time) | |
sort | string | |
until | string (date-time) |
SELECT examples
- list
Retrieves a list of summarised aggregate metrics over a given time period. See Analytics API properties for detailed information about the available query parameters.
SELECT
dimensions,
metrics
FROM cloudflare.dns.reports
WHERE zone_id = '{{ zone_id }}' -- required
AND metrics = '{{ metrics }}'
AND dimensions = '{{ dimensions }}'
AND since = '{{ since }}'
AND until = '{{ until }}'
AND limit = '{{ limit }}'
AND sort = '{{ sort }}'
AND filters = '{{ filters }}'
;