Analytics

AnalyticsReports

Table

client.DNS.Analytics.Reports.Get(ctx, params) (*Report, error)

GET/zones/{zone_id}/dns_analytics/report

ModelsExpand Collapse

type Report struct{…}

Data []ReportData

Array with one row per combination of dimension values.

Dimensions []string

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

Metrics []float64

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

DataLag float64

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 ReportQuery

Dimensions []string

Array of dimension names.

Limit int64

Limit number of returned metrics.

Metrics []string

Array of metric names.

Since Time

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

formatdate-time

Until Time

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

formatdate-time

Filters stringoptional

Segmentation filter in 'attribute operator value' format.

Sort []stringoptional

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

Rows float64

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

client.DNS.Analytics.Reports.Bytimes.Get(ctx, params) (*ByTime, error)

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

ModelsExpand Collapse

type ByTime struct{…}

Data []ByTimeData

Array with one row per combination of dimension values.

Dimensions []string

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

Metrics [][]float64

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

DataLag float64

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 ByTimeQuery

Dimensions []string

Array of dimension names.

Limit int64

Limit number of returned metrics.

Metrics []string

Array of metric names.

Since Time

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

formatdate-time

TimeDelta ByTimeQueryTimeDelta

Unit of time to group data by.

One of the following:

const ByTimeQueryTimeDeltaAll ByTimeQueryTimeDelta = "all"

const ByTimeQueryTimeDeltaAuto ByTimeQueryTimeDelta = "auto"

const ByTimeQueryTimeDeltaYear ByTimeQueryTimeDelta = "year"

const ByTimeQueryTimeDeltaQuarter ByTimeQueryTimeDelta = "quarter"

const ByTimeQueryTimeDeltaMonth ByTimeQueryTimeDelta = "month"

const ByTimeQueryTimeDeltaWeek ByTimeQueryTimeDelta = "week"

const ByTimeQueryTimeDeltaDay ByTimeQueryTimeDelta = "day"

const ByTimeQueryTimeDeltaHour ByTimeQueryTimeDelta = "hour"

const ByTimeQueryTimeDeltaDekaminute ByTimeQueryTimeDelta = "dekaminute"

const ByTimeQueryTimeDeltaMinute ByTimeQueryTimeDelta = "minute"

Until Time

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

formatdate-time

Filters stringoptional

Segmentation filter in 'attribute operator value' format.

Sort []stringoptional

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

Rows float64

Total number of rows in the result.

minimum0

TimeIntervals [][]Time

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).