--- metadata: - name: generator content: Diplodoc Platform v5.52.0 alternate: - https://appmetrica.yandex.com/docs/en/mobile-api/stat/intro.md - https://appmetrica.yandex.com/docs/ru/mobile-api/stat/intro.md - href: ru/mobile-api/stat/intro.md type: text/markdown title: Markdown version - href: ../../llms.txt type: text/markdown title: llms.txt --- > **Documentation Index:** Fetch the complete configuration index at https://appmetrica.yandex.com/docs/ru/llms.txt # Введение API отчетов позволяет получать информацию о статистике приложения, не используя интерфейс AppMetrica. При формировании запроса к API используются измерения (dimensions) и метрики (metrics). - Группировка (dimension) — это атрибут, по которому группируются данные. В запросах к API группировки задаются в параметре `dimensions`. Если необходимо указать несколько группировок, перечислите их через запятую. Также возможен отчет без группировок, в этом случае будет рассчитан суммарный результат. - Метрика (metric) — числовая величина, которая рассчитывается на основе атрибута сессии. В запросах к API метрики задаются в параметре `metrics`. Если необходимо указать несколько метрик, перечислите их через запятую. {% cut "Подробно о терминах" %} Предлагаем подробнее узнать о понятиях «группировка» и «метрика» на примере отчета по производителю устройства: | Название производителя устройства | Количество пользователей | | ----- | ----- | | Apple | | 1803 | | Samsung | 1272 | | NOKIA | 809 | где - `Название производителя устройства` — атрибут визита, по которому сгруппированы данные отчета (_группировка_). - `Количество пользователей` — значение, рассчитанное на основе числовых атрибутов визитов (_метрика_), соответствующее указанной группировке. {% note info "" %} Если вы знакомы с языком SQL, измерения можно представить как колонки, по которым происходит группировка, а метрики — как результаты вычисления агрегатных функций. {% endnote %} {% endcut %} Метрики и группировки, указанные в запросе к API, позволяют формировать необходимую структуру отчета. Например, чтобы получить отчет по количеству пользователей приложения с группировкой по производителю и названию модели устройства, используйте такой запрос: ```httpget translate=no 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.com Authorization: OAuth ``` где `` — это OAuth-токен, который можно получить по [инструкции](https://appmetrica.yandex.com/docs/ru/mobile-api/intro/authorization.md#get-oauth-token). {% cut "Пример ответа" %} ```json translate=no { "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 ] } ``` {% endcut %} Для получения текста запроса к API отчетов вы можете воспользоваться меню **Экспорт** в интерфейсе AppMetrica. Для этого откройте отчет, сформируйте сегмент, временной интервал, группировку и нажмите кнопку **Экспорт** над графиком. В меню выберите **Скопировать API-запрос таблицы** или **Скопировать API-запрос графика**. Подробнее об экспорте данных в разделе [Работа с отчетами](https://appmetrica.yandex.com/docs/ru/mobile-reports/index.md). ## Совместимость группировок и метрик {#comp} API поддерживает несколько типов группировок и метрик, отличающихся префиксом: - `ym:ge:` — группировка или метрика любой активности. - `ym:ce:` — признак отправки вашего события. - `ym:c:` — используется в отчетах по трекингу, признак клика. - `ym:i:` — используется в отчетах по трекингу, признак установки приложения. - `ym:s:` — используется в группировках Сессии. В одном запросе нельзя использовать разные префиксы. {% note info "" %} Вы можете указать префикс отличный от заданного в запросе при использовании параметра `filters` для сегментирования полученных данных по группировкам. {% endnote %} ## Виды отчетов {#report-type} Полученные данные могут быть представлены в следующих формах: {% list tabs %} - Таблица Все уровни отчета и метрики представлены в виде таблицы. Чтобы отображать данные в виде таблицы, используйте метод [/stat/v1/data](https://appmetrica.yandex.com/docs/ru/mobile-api/stat/ref/data). - Drill down Формирование одной ветви древовидного отчета. Чтобы сформировать ветвь, используйте метод [/stat/v1/data/drilldown](https://appmetrica.yandex.com/docs/ru/mobile-api/stat/ref/drilldown). - По времени Отображает данные с разбивкой по времени (например, по дням, неделям, месяцам). Используйте запрос [/stat/v1/data/bytime](https://appmetrica.yandex.com/docs/ru/mobile-api/stat/ref/bytime) для построения графиков и отслеживания динамики. {% endlist %} ## Формат отчетов {#report-format} API возвращает ответы в кодировке UTF-8. Ответы имеют формат JSON или CSV. Формат указывается в запросе после пути URL: ``` GET https://api.appmetrica.yandex.com/stat/v1/data.**csv**?&& ``` Так как формат JSON является форматом, принятым по умолчанию, его можно не указывать: ``` GET https://api.appmetrica.yandex.com/stat/v1/data?&& ``` Если вы не нашли ответ на свой вопрос, то вы можете задать его через форму обратной связи. Пожалуйста, опишите возникшую проблему как можно подробнее. Если возможно, приложите скриншот. Написать в службу поддержки Предложить улучшение для документации