Analytics

AnalyticsReports

Table

GET/zones/{zone_id}/dns_analytics/report

ModelsExpand Collapse

Report = object { data, data_lag, max, 4 more }

data: array of object { dimensions, metrics }

Array with one row per combination of dimension values.

dimensions: array of string

Array of dimension values, representing the combination of dimension values corresponding to this row.

metrics: array of number

Array with one item per requested metric. Each item is a single value.

data_lag: number

Number of seconds between current time and last processed event, in another words how many seconds of data could be missing.

minimum0

max: unknown

Maximum results for each metric (object mapping metric names to values). Currently always an empty object.

min: unknown

Minimum results for each metric (object mapping metric names to values). Currently always an empty object.

query: object { dimensions, limit, metrics, 4 more }

dimensions: array of string

Array of dimension names.

limit: number

Limit number of returned metrics.

metrics: array of string

Array of metric names.

since: string

Start date and time of requesting data period in ISO 8601 format.

formatdate-time

until: string

End date and time of requesting data period in ISO 8601 format.

formatdate-time

filters: optional string

Segmentation filter in 'attribute operator value' format.

sort: optional array of string

Array of dimensions to sort by, where each dimension may be prefixed by - (descending) or + (ascending).

rows: number

Total number of rows in the result.

minimum0

totals: unknown

Total results for metrics across all data (object mapping metric names to values).

AnalyticsReportsBytimes

By Time

GET/zones/{zone_id}/dns_analytics/report/bytime

ModelsExpand Collapse

ByTime = object { data, data_lag, max, 5 more }

data: array of object { dimensions, metrics }

Array with one row per combination of dimension values.

dimensions: array of string

Array of dimension values, representing the combination of dimension values corresponding to this row.

metrics: array of array of number

Array with one item per requested metric. Each item is an array of values, broken down by time interval.

data_lag: number

Number of seconds between current time and last processed event, in another words how many seconds of data could be missing.

minimum0

max: unknown

Maximum results for each metric (object mapping metric names to values). Currently always an empty object.

min: unknown

Minimum results for each metric (object mapping metric names to values). Currently always an empty object.

query: object { dimensions, limit, metrics, 5 more }

dimensions: array of string

Array of dimension names.

limit: number

Limit number of returned metrics.

metrics: array of string

Array of metric names.

since: string

Start date and time of requesting data period in ISO 8601 format.

formatdate-time

time_delta: "all" or "auto" or "year" or 7 more

Unit of time to group data by.

One of the following:

"all"

"auto"

"year"

"quarter"

"month"

"week"

"day"

"hour"

"dekaminute"

"minute"

until: string

End date and time of requesting data period in ISO 8601 format.

formatdate-time

filters: optional string

Segmentation filter in 'attribute operator value' format.

sort: optional array of string

Array of dimensions to sort by, where each dimension may be prefixed by - (descending) or + (ascending).

rows: number

Total number of rows in the result.

minimum0

time_intervals: array of array of string

Array of time intervals in the response data. Each interval is represented as an array containing two values: the start time, and the end time.

totals: unknown

Total results for metrics across all data (object mapping metric names to values).