Введение

API отчетов позволяет получать информацию о статистике приложения, не используя интерфейс AppMetrica.

При формировании запроса к API используются измерения (dimensions) и метрики (metrics).

Группировка (dimension) — это атрибут, по которому группируются данные.

В запросах к API группировки задаются в параметре dimensions. Если необходимо указать несколько группировок, перечислите их через запятую.

Также возможен отчет без группировок, в этом случае будет рассчитан суммарный результат.

Метрика (metric) — числовая величина, которая рассчитывается на основе атрибута сессии.

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

Подробно о терминах

Предлагаем подробнее узнать о понятиях «группировка» и «метрика» на примере отчета по производителю устройства:


Название производителя устройства	Количество пользователей
Apple	1803
Samsung	1272
NOKIA	809

Где

Название производителя устройства — атрибут визита, по которому сгруппированы данные отчета (группировка).
Количество пользователей — значение, рассчитанное на основе числовых атрибутов визитов (метрика), соответствующее указанной группировке.

Примечание.

Если вы знакомы с языком SQL, измерения можно представить как колонки, по которым происходит группировка, а метрики — как результаты вычисления агрегатных функций.

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

Например, чтобы получить отчет по количеству пользователей приложения с группировкой по производителю и названию модели устройства, используйте такой запрос:

GET /stat/v1/data?id=1111&metrics=ym:ge:users&dimensions=ym:ge:mobileDeviceBranding,ym:ge:mobileDeviceModel&limit=5 HTTP/1.1
Host: api.appmetrica.yandex.ru
Authorization: OAuth 05dd3dd84ff948fdae2bc4fb91f13e22bb1f289ceef0037

Пример ответа

{

    "query": {
        "ids": [
            1111
        ],
        "dimensions": [
            "ym:ge:mobileDeviceBranding",
            "ym:ge:mobileDeviceModel"
        ],
        "metrics": [
            "ym:ge:users"
        ],
        "sort": [
            "-ym:ge:users"
        ],
        "date1": "2015-08-28",
        "date2": "2015-09-03",
        "limit": 5,
        "offset": 1

    },
    "data": [
        {
            "dimensions": [
                {
                    "name": "Apple"
                },
                {
                    "name": "iPad 4"
                }

            ],
            "metrics": [
                1240
            ]
        },
        {

            "dimensions": [
                {
                    "name": "Apple"

                },
                {
                    "name": "iPad mini 1G"
                }

            ],
            "metrics": [
                1236
            ]
        },
        {
            "dimensions": [
                { 
                    "name": "Apple"
                },
                {
                    "name": "iPad Air"
                }
            ],
            "metrics": [
                948
            ]
        },
        {
            "dimensions": [
                {
                    "name": "Apple"
                },
                {
                    "name": "iPad 2"
                }
            ],
            "metrics": [
                866
            ]
        },
        {

            "dimensions": [
                {
                    "name": "Apple"
                },
                {
                    "name": "iPad 3"
                }
            ],
            "metrics": [
                661
            ]
        }
    ],
    "total_rows": 1163,
    "sampled": false,
    "sample_share": 1,
    "sample_size": 12258000,
    "sample_space": 12258000,
    "data_lag": 0,
    "totals": [
        13290
    ],
    "min": [
        661
    ],
    "max": [
        1240
    ]

}

Для получения текста запроса к API отчетов вы можете воспользоваться меню Экспорт в интерфейсе AppMetrica. Для этого откройте отчет, сформируйте сегмент, временной интервал, группировку и нажмите кнопку Экспорт над графиком. В меню выберите Скопировать API-запрос таблицы или Скопировать API-запрос графика. Подробнее об экспорте данных в разделе Работа с отчетами.

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

API поддерживает несколько типов группировок и метрик, отличающихся префиксом:

ym:ge: — группировка или метрика любой активности.
ym:ce: — признак отправки вашего события.
ym:c: — используется в отчетах по трекингу, признак клика.
ym:i: — используется в отчетах по трекингу, признак установки приложения.
ym:s: — используется в группировках Сессии.

В одном запросе нельзя использовать разные префиксы.

Примечание. Вы можете указать префикс отличный от заданного в запросе при использовании параметра filters для сегментирования полученных данных по группировкам.

Виды отчетов

Полученные данные могут быть представлены в следующих формах:

Все уровни отчета и метрики представлены в виде таблицы.

Чтобы отображать данные в виде таблицы, используйте метод /stat/v1/data.

Формирование одной ветви древовидного отчета.

Чтобы сформировать ветвь, используйте метод /stat/v1/data/drilldown.

Формат отчетов

API возвращает ответы в кодировке UTF-8. Ответы имеют формат JSON или CSV.

Формат указывается в запросе после пути URL:

GET https://api.appmetrica.yandex.ru/stat/v1/data.csv?<counter_id>&<metrics>&<dimensions>

Так как формат JSON является форматом, принятым по умолчанию, его можно не указывать:

GET https://api.appmetrica.yandex.ru/stat/v1/data?<counter_id>&<metrics>&<dimensions>