Свойства Analytics API

На этой странице описаны свойства API, которые можно использовать в запросах к API аналитики DNS.

Метрики

Метрика представляет собой числовое значение, основанное на атрибуте данных, например на количестве запросов.

В API-запросах метрики задаются в metrics параметр. Если нужно указать несколько метрик, разделите их запятыми.

Метрика	Название	Пример	Единица
queryCount	Количество запросов	`1000`	Количество
uncachedCount	Количество некэшированных запросов	`1`	Количество
staleCount	Количество устаревших запросов	`1`	Количество
responseTimeAvg	Среднее время ответа	`1.0`	Время в миллисекундах
responseTimeMedian	Медианное время отклика	`1.0`	Время в миллисекундах
responseTime90th	время отклика на 90-м процентиле	`1.0`	Время в миллисекундах
responseTime99th	время отклика на 99-м процентиле	`1.0`	Время в миллисекундах

С помощью измерений можно группировать данные по заданным атрибутам.

В API-запросах измерения задаются в dimensions параметр. Если нужно указать несколько измерений, разделите их запятыми.

Измерение	Название	Пример	Примечания
queryName	Query Name	`example.com`
queryType	Query Type	`AAAA`	Типы, определённые IANA ↗. Неизвестные типы остаются пустыми.
responseCode	Код ответа	`NOERROR`	Коды ответов, определённые IANA ↗. Всегда в верхнем регистре.
responseCached	Ответ кэширован	`Cached`	Либо `Cached` или `Uncached`.
coloName	Название дата-центра	`SJC`	Код PoP.
источник	Origin	`2001:db8::1`	Origin, использованный для разрешения запроса. Пусто, если недоступно или если запрос был обработан из кеша.
dayOfWeek	День недели	`1`	Разбивка по дням недели. Понедельник соответствует `1`, а воскресенье составляет `7`.
tcp	TCP	`1`	Либо `1` или `0` в зависимости от используемого протокола.
ipVersion	Версия IP	`6`	Используемая версия протокола IP (в настоящее время `4` или `6`).
querySizeBucket	Query Size Bucket	`16-31`	Диапазон размера запроса с шагом 16.
responseSizeBucket	Интервал размера ответа	`16-31`	Интервал размера ответа с шагом 16.

Фильтры используют форму dimension operator expression, где каждая часть соответствует следующему:

Измерение: Определяет измерение для фильтрации. Например, queryName.
Оператор: Определяет тип соответствия фильтра. Операторы зависят от конкретных измерений.
Выражение: Задает значения, которые нужно включить в результаты или исключить из них. Выражения используют синтаксис регулярных выражений (regex).

Оператор	Название	Пример	Описание	URL Encoded
`==`	Equals	`queryName==example.com`	Возвращать результаты, где `queryName` равен точно `example.com`.	`%3D%3D`
`!=`	Не равно	`responseCode!=NOERROR`	Возвращать результаты, где `responseCode` отличается от `NOERROR`.	`!%3D`
`>`	Больше	`dimension>1000`	Возвращать результаты, где значение измерения больше `1000`.	`%3E`
`<`	Меньше	`dimension<1000`	Возвращать результаты, где значение измерения меньше `1000`.	`%3C`
`>=`	Больше или равно	`dimension>=1000`	Возвращать результаты, где значение измерения больше или равно `1000`.	`%3E%3D`
`<=`	Меньше или равно	`dimension<=1000`	Возвращать результаты, где значение измерения меньше или равно `1000`.	`%3C%3D`

Комбинируйте фильтры с помощью OR и AND булева логика:

AND имеет приоритет над OR во всех выражениях.
OR оператор задаётся запятой , или OR ключевое слово, окружённое пробельными символами.
AND оператор задаётся точкой с запятой ; или AND ключевое слово, окружённое пробельными символами.

Примечание
Учтите, что точка с запятой является зарезервированным символом в URL-адресах (RFC 1738 ↗) и должен быть представлен в percent-encoding как %3B.

Примеры с использованием OR

responseCode==NOERROR,responseCode==NXDOMAIN указывает, что код ответа либо NOERROR или NXDOMAIN.
coloName==SJC OR coloName==LAX указывает на запросы либо в SJC или LAX.

Примеры с использованием AND

responseCode==NOERROR;queryType==AAAA указывает, что код ответа NOERROR и тип запроса AAAA.
queryType==AAAA AND coloName==SJC указывает на AAAA запросы в SJC.