--- metadata: - name: generator content: Diplodoc Platform v5.52.0 alternate: - https://yandex.com/dev/metrika/en/stat/index.md - https://yandex.com/dev/metrika/ru/stat/index.md - href: ru/stat/index.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://yandex.com/dev/metrika/ru/llms.txt # Введение API отчетов позволяет получать информацию о статистике посещений сайта и другие данные, не используя интерфейс Яндекс Метрики. При формировании запроса к API используются группировки (dimensions) и метрики (metrics). _Группировка_ (dimension) — это атрибут визита или хита, по которому можно сгруппировать данные. В запросах к API группировки задаются в параметре `dimensions`. Если необходимо указать несколько группировок, перечислите их через запятую. Также возможен отчет без группировок, в этом случае будет рассчитан суммарный результат. _Метрика_ (metric) — числовая величина, которая рассчитывается на основе атрибута хита или визита. В запросах к API метрики задаются в параметре `metrics`. Если необходимо указать несколько метрик, перечислите их через запятую. {% cut "Подробно о терминах" %} Предлагаем подробнее узнать о понятиях «группировка» и «метрика» на примере отчета Яндекс Метрики по операционной системе: #| || **Операционная система** | **Глубина просмотра** || || Windows | 4,2 || || iOS | 3,1 || || Linux | 1,6 || |# Где - `Операционная система` — атрибут визита, по которому сгруппированы данные отчета (_группировка_). - `Глубина просмотра` — значение, рассчитанное на основе числовых атрибутов визитов (_метрика_), соответствующее указанной группировке. {% note info %} Если вы знакомы с языком SQL, группировки можно представить как колонки, по которым происходит объединение данных, а метрики — как результаты вычисления агрегатных функций. Например, приведенный выше отчет можно представить, как запрос к гипотетической таблице визитов: ```xml translate=no SELECT operatingSystem, avg(depth) from visits GROUP BY operatingSystem ``` {% endnote %} {% endcut %} Метрики и группировки, указанные в запросе к API, позволяют формировать необходимую вам структуру отчета. Например, чтобы получить отчет по глубине просмотра с группировкой данных по типу и версии операционной системы, используйте такой запрос: ``` https://api-metrika.yandex.net/stat/v1/data.csv?id=44147844&metrics=ym:s:avgPageViews&dimensions=ym:s:operatingSystem&limit=5 ``` ## Совместимость группировок и метрик {#comp} API поддерживает два типа группировок и метрик: - Визиты — имеют префикс `ym:s:`. - Хиты — имеют префикс `ym:pv:`. В одном запросе нельзя использовать разные префиксы, а также указывать больше одного множества (см. раздел [Сегментация. Множества и отношения](https://yandex.com/dev/metrika/ru/stat/segmentation.md#sets)). {% note alert %} Вы можете указать префикс отличный от заданного в запросе и различные множества при использовании параметра `filters` для фильтрации полученных данных по группировкам. Например, данный запрос формирует отчет по количеству визитов и уникальных посетителей, перешедших из поисковых систем на указанную в запросе страницу: ``` https://api-metrika.yandex.net/stat/v1/data?dimensions=ym:s:searchEngineName&metrics=ym:s:visits,ym:s:users&filters=ym:s:trafficSourceName=='Переходы из поисковых систем' AND ym:pv:URL=@'help'&id=44147844 ``` где - `dimensions=ym:s:searchEngineName` — группировка данных по параметру `ym:s:searchEngine` (типу поисковой системы); - `metrics=ym:s:visits,ym:s:users` — количество визитов и посетителей; - `filters=ym:s:trafficSourceName=='Переходы из поисковых систем' AND ym:pv:URL=@'help'` — сегментация данных по группировкам `ym:s:trafficSourceName` и `ym:pv:URL`. {% endnote %} ## Виды отчетов {#report-type} Полученные данные могут быть представлены в следующих формах: {% list tabs %} - Таблица Все уровни отчета и метрики представлены в виде таблицы. Чтобы отображать данные в виде таблицы, используйте метод [/stat/v1/data](https://yandex.com/dev/metrika/ru/stat/openapi/data.md). - Drill down Формирование одной ветви древовидного отчета. Чтобы сформировать ветвь, используйте метод [/stat/v1/data/drilldown](https://yandex.com/dev/metrika/ru/stat/openapi/drilldown.md). - По времени Данные представлены с разбивкой по времени (например, по дням, неделям и месяцам). Форма удобна для построения графиков и отслеживания динамики. Используйте метод [/stat/v1/data/bytime](https://yandex.com/dev/metrika/ru/stat/openapi/bytime.md). - Сравнение-Таблица Сравнение сегментов, указанных в одном запросе. Данные представлены в виде таблицы. Используйте метод [/stat/v1/data/comparison](https://yandex.com/dev/metrika/ru/stat/openapi/comparison.md). - Сравнение-Drilldown Сравнение сегментов, указанных в одном запросе. Данные представлены в древовидном отчете. Используйте метод [/stat/v1/data/comparison/drilldown](https://yandex.com/dev/metrika/ru/stat/openapi/comparison_drilldown.md). {% endlist %} ## Формат отчетов {#report-format} API возвращает ответы в кодировке UTF-8. Ответы имеют формат JSON или CSV. Формат указывается в запросе после пути URL: ``` GET https://api-metrika.yandex.net/stat/v1/data.**csv**?&& ``` Так как формат JSON является форматом, принятым по умолчанию, его можно не указывать: ``` GET https://api-metrika.yandex.net/stat/v1/data?&& ``` ## Раскрытие данных {#disclosure} Яндекс Метрика заботится о конфиденциальности посетителей и сохраняет обезличенность собранной информации. Поэтому некоторые данные, например, [социально-демографические](https://yandex.com/dev/metrika/ru/stat/presets/visitors/preset_socdem.md) (пол, возраст и др.) раскрываются с ограничениями. Они выдаются только в том случае, если количество посетителей в выборке больше 10. Подробнее про [обезличенность статистики](https://yandex.ru/support/metrica/reports/report-general.html?lang=ru#privacy). Например, необходимо узнать долю мужчин от количества посетителей за день. На момент отправки запроса сайт посетили 5 человек (менее 10). При таком условии ответ будет содержать информацию об общем количестве посетителей за день, но данные о количестве мужчин будут недоступны. ### Как понять, что в ответе API ограниченные данные? В ответе API есть параметр `contains_sensitive_data`. Если он принимает значение `true`, то данные предоставляются с ограничениями.