Analytics

AnalyticsReports

Table

dns.analytics.reports.get() -> Report

GET/zones/{zone_id}/dns_analytics/report

ModelsExpand Collapse

class Report: …

data: List[Data]

Array with one row per combination of dimension values.

dimensions: List[str]

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

metrics: List[float]

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

data_lag: float

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

minimum0

max: object

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

min: object

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

query: Query

dimensions: List[str]

Array of dimension names.

limit: int

Limit number of returned metrics.

metrics: List[str]

Array of metric names.

since: datetime

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

formatdate-time

until: datetime

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

formatdate-time

filters: Optional[str]

Segmentation filter in 'attribute operator value' format.

sort: Optional[List[str]]

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

rows: float

Total number of rows in the result.

minimum0

totals: object

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

AnalyticsReportsBytimes

By Time

dns.analytics.reports.bytimes.get() -> ByTime

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

ModelsExpand Collapse

class ByTime: …

data: List[Data]

Array with one row per combination of dimension values.

dimensions: List[str]

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

metrics: List[List[float]]

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

data_lag: float

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

minimum0

max: object

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

min: object

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

query: Query

dimensions: List[str]

Array of dimension names.

limit: int

Limit number of returned metrics.

metrics: List[str]

Array of metric names.

since: datetime

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

formatdate-time

time_delta: Literal["all", "auto", "year", 7 more]

Unit of time to group data by.

One of the following:

"all"

"auto"

"year"

"quarter"

"month"

"week"

"day"

"hour"

"dekaminute"

"minute"

until: datetime

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

formatdate-time

filters: Optional[str]

Segmentation filter in 'attribute operator value' format.

sort: Optional[List[str]]

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

rows: float

Total number of rows in the result.

minimum0

time_intervals: List[List[datetime]]

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: object

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