Таблица

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

Request

GET

https://api.appmetrica.yandex.net/stat/v1/data

Query parameters

Name	Description
params*	Type: ConstructorParams
statGroupParams*	Type: StatGroupParams

ConstructorParams

Name	Description
access_filter_id	Type: integer<int32>
accuracy	Type: string
callback	Type: string
confidence_level	Type: string Default: `0.95`
date1	Type: string Default: `6daysAgo`
date2	Type: string Default: `today`
date_dimension	Type: string
dimensions	Type: string
direct_client_ids	Type: integer[]
direct_client_logins	Type: string[]
exclude_insignificant	Type: boolean
filters	Type: string
ids	Type: integer[]
include_meta	Type: boolean
include_undefined	Type: boolean
lang	Type: string
limit	Type: string Default: `100`
max_deviation	Type: string Default: `0.1`
metrics	Type: string
offset	Type: string Default: `1`
preset	Type: string
pretty	Type: string Default: `false`
proposed_accuracy	Type: boolean
reference_row_id	Type: string[]
request_domain	Type: string
require_metric_values	Type: string Default: `false`
sort	Type: string
timezone	Type: string
with_confidence	Type: boolean

StatGroupParams

Name

Description

label_id

Type: integer<int32>

Min value: 1

org_id

Type: integer<int64>

Min value: 1

Responses

200 OK

Body

application/json

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

Name	Description
contains_sensitive_data	Type: boolean Признак возможного отсутствия конфиденциальных данных в ответе. К ним относятся данные, которые рассчитываются алгоритмами Яндекса, например, социально-демографические (пол, возраст и др.), адреса страниц входа, поисковые фразы, информация о роботах. При значении `true` в ответе не отобразятся такие данные, если выборка составляет меньше 10 посетителей. Возможные значения: `true`, `false`.
data	Type: StaticRow[] Строки ответа. Представляет собой массив, каждый элемент которого — одна строка результата.
data_lag	Type: integer<int32> Задержка в обновлении данных, в секундах.
max	Type: number[] Максимальные результаты для метрик среди попавших в выдачу ключей.
min	Type: number[] Минимальные результаты для метрик среди попавших в выдачу ключей.
query	Type: QueryExternal Исходный запрос. Содержит параметры запроса, включая развернутые параметры из шаблона и параметры для схемы параметризации атрибутов.
sample_share	Type: number<double> Доля данных, по которым осуществлялся расчет. Доступно значение в пределах от 0 до 1.
sample_size	Type: integer<int64> Количество строк в выборке данных.
sample_space	Type: integer<int64> Количество строк данных.
sampled	Type: boolean Признак семплирования. Показывает, был ли применен семплинг. Возможные значения: `true`, `false`.
total_rows	Type: integer<int64> Общее количество строк в ответе по всему множеству данных (с учетом фильтра).
total_rows_rounded	Type: boolean Признак того, что общее количество строк было округлено.
totals	Type: number[] Общие результаты для метрик по всему множеству данных (с учетом фильтра).

StaticRow

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

Name

Description

dimensions

Type: object[]

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

metrics

Type: number[]

Массив значений метрик для данной строки. Значения этого массива — числа или null.

QueryExternal

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

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

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

Операторы

Drill down