Skip to main content

reports

Creates, updates, deletes, gets or lists a reports resource.

Overview

Namereports
TypeResource
Idcloudflare.dns.reports

Fields

The following fields are returned by SELECT queries:

Table response

NameDatatypeDescription
dimensionsarrayArray of dimension values, representing the combination of dimension values corresponding to this row.
metricsarrayArray with one item per requested metric. Each item is a single value.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
listselectzone_idmetrics, dimensions, since, until, limit, sort, filtersRetrieves 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.

NameDatatypeDescription
zone_idstringThe Cloudflare zone ID.
dimensionsstring
filtersstring
limitinteger
metricsstring
sincestring (date-time)
sortstring
untilstring (date-time)

SELECT examples

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 }}'
;