Таблица

Предоставляет доступ к статистическим данным Яндекс Метрики, включая данные, доступные в отчетах. Возвращает результат в виде таблицы.

Request

GET

https://api-metrika.yandex.net/stat/v1/data

Query parameters

Name	Description
ids	Type: integer[] Идентификаторы счетчиков, через запятую. Example: `44147844,2215573`
metrics	Type: string Список метрик, разделенных запятой. Лимит: 20 метрик в запросе. Example: `ym:s:pageviews`
accuracy	Type: string Размер выборки, используемой для отчета. Позволяет управлять семплированием (количеством визитов, использованных при расчете итогового значения). Example: ``
callback	Type: string Функция обратного вызова, которая обрабатывает ответ API. Example: ``
date1	Type: string Дата начала периода выборки в формате YYYY-MM-DD. Также используйте значения: `today`, `yesterday`, `ndaysAgo`. Default: `6daysAgo` Example: ``
date2	Type: string Дата окончания периода выборки в формате YYYY-MM-DD. Также используйте значения: `today`, `yesterday`, `ndaysAgo`. Default: `today` Example: ``
dimensions	Type: string Список группировок, разделенных запятой. Лимит: 10 группировок в запросе. Example: `ym:s:trafficSource`
direct_client_logins	Type: string[] Логины клиентов Яндекс Директа, через запятую. Могут использоваться для формирования отчета Директ-расходы. Example: `login1,login2`
filters	Type: string Фильтр сегментации. Лимит: количество уникальных группировок и метрик — до 10, количество отдельных фильтров — до 20, длина строки в фильтре — до 10 000 символов; количество значений в одном условии фильтрации — 100. Example: ``
include_undefined	Type: boolean Включает в ответ строки, для которых значения группировок не определены. Влияет только на первую группировку. По умолчанию выключено.
lang	Type: string Язык. Example: ``
limit	Type: string Количество элементов на странице выдачи. Лимит: 100 000. Default: `100` Example: ``
offset	Type: string Индекс первой строки выборки, начиная с 1. Default: `1` Example: ``
preset	Type: string Шаблон отчета. Example: `sources_summary`
pretty	Type: string Задает форматирование результата. Чтобы использовать форматирование, укажите значение `true`. Default: `false` Example: ``
proposed_accuracy	Type: boolean Если параметр выставлен в `true`, API имеет право автоматически увеличивать accuracy до рекомендованного значения.Когда идет запрос в маленькую таблицу с очень маленьким семплингом, параметр поможет получить осмысленные результаты.
sort	Type: string Список группировок и метрик, разделенных запятой, по которым осуществляется сортировка. По умолчанию сортировка производится по убыванию (указан знак `-` перед группировкой или метрикой). Чтобы отсортировать данные по возрастанию, удалите знак `-`. Example: ``
timezone	Type: string Часовой пояс в формате ±hh:mm в диапазоне [-23:59; +23:59] (знак плюса нужно передавать как `%2B`), в котором будут рассчитан период выборки запроса, а также связанные с датой и временем группировки. По умолчанию используется часовой пояс счетчика. Example: `+03:00`

Responses

200 OK

Body

application/json

{
  "query": {
    "timezone": "example",
    "preset": "example",
    "dimensions": [
      "example"
    ],
    "metrics": [
      "example"
    ],
    "sort": [
      "example"
    ],
    "date1": "example",
    "date2": "example",
    "filters": "example",
    "limit": 0,
    "offset": 0
  },
  "data": [
    {
      "dimensions": [
        {}
      ],
      "metrics": [
        0.5
      ]
    }
  ],
  "total_rows": 0,
  "total_rows_rounded": true,
  "sampled": true,
  "contains_sensitive_data": true,
  "sample_share": 0.5,
  "sample_size": 0,
  "sample_space": 0,
  "data_lag": 0,
  "totals": [
    0.5
  ],
  "min": [
    0.5
  ],
  "max": [
    0.5
  ]
}

Name	Description
contains_sensitive_data	Type: boolean Признак возможного отсутствия конфиденциальных данных в ответе. К ним относятся данные, которые рассчитываются алгоритмами Яндекса, например, социально-демографические (пол, возраст и др.), адреса страниц входа, поисковые фразы, информация о роботах. При значении `true` в ответе не отобразятся такие данные, если выборка составляет меньше 10 посетителей. Возможные значения: `true`, `false`.
data	Type: StaticRow[] Example `[ { "dimensions": [ {} ], "metrics": [ 0.5 ] } ]`
data_lag	Type: integer Задержка в обновлении данных, в секундах.
max	Type: number[] Example `[ 0.5 ]`
min	Type: number[] Example `[ 0.5 ]`
query	Type: QueryExternal Исходный запрос. Содержит параметры запроса, включая развернутые параметры из шаблона и параметры для схемы параметризации атрибутов. Example `{ "timezone": "example", "preset": "example", "dimensions": [ "example" ], "metrics": [ "example" ], "sort": [ "example" ], "date1": "example", "date2": "example", "filters": "example", "limit": 0, "offset": 0 }`
sample_share	Type: number Доля данных, по которым осуществлялся расчет. Доступно значение в пределах от 0 до 1.
sample_size	Type: integer Количество строк в выборке данных.
sample_space	Type: integer Количество строк данных.
sampled	Type: boolean Признак семплирования. Показывает, был ли применен семплинг. Возможные значения: `true`, `false`.
total_rows	Type: integer Общее количество строк в ответе по всему множеству данных (с учетом фильтра).
total_rows_rounded	Type: boolean Признак того, что общее количество строк было округлено.
totals	Type: number[] Example `[ 0.5 ]`

QueryExternal

Исходный запрос. Содержит параметры запроса, включая развернутые параметры из шаблона и параметры для схемы параметризации атрибутов.

Name	Description
date1	Type: string Дата начала периода выборки в формате YYYY-MM-DD. Example: `example`
date2	Type: string Дата окончания периода выборки в формате YYYY-MM-DD. Example: `example`
dimensions	Type: string[] Example `[ "example" ]`
filters	Type: string Фильтр сегментации. Example: `example`
limit	Type: integer Количество элементов на странице выдачи.
metrics	Type: string[] Example `[ "example" ]`
offset	Type: integer Индекс первой строки выборки, начиная с 1.
preset	Type: string Пресет отчета. Example: `example`
sort	Type: string[] Example `[ "example" ]`
timezone	Type: string Часовой пояс периода выборки в формате ±hh:mm. Example: `example`

Example

{
  "timezone": "example",
  "preset": "example",
  "dimensions": [
    "example"
  ],
  "metrics": [
    "example"
  ],
  "sort": [
    "example"
  ],
  "date1": "example",
  "date2": "example",
  "filters": "example",
  "limit": 0,
  "offset": 0
}

StaticRow

Строки ответа. Представляет собой массив, каждый элемент которого — одна строка результата.

Name

Description

dimensions

Type: object[]

[additional]

Type: string

Example: example

Массив значений группировок для данной строки. Каждое из значений группировки представляет собой объект. В нем обязательно присутствует поле name — текстовое значение, но могут присутствовать дополнительные поля, например идентификатор — id.

Example

[
  {}
]

metrics

Type: number[]

Example

[
  0.5
]

Example

{
  "dimensions": [
    {}
  ],
  "metrics": [
    0.5
  ]
}

Была ли статья полезна?

Список группировок и метрик

Получение сводной таблицы