--- metadata: - name: generator content: Diplodoc Platform v5.46.1 alternate: - https://yandex.com/dev/partner-statistics/doc/en/reference/statistics-get2.md - https://yandex.com/dev/partner-statistics/doc/ru/reference/statistics-get2.md --- > **Documentation Index:** Fetch the complete configuration index at https://yandex.com/dev/partner-statistics/doc/ru/llms.txt # Отчет по статистике Строит отчет по выбранному уровню статистики за указанный период. ## Формат запроса {#input} ``` https://partner.yandex.ru/api/statistics2/get ? [lang](*lang)= & [[pretty](*pretty)=] & [[period](*period)=] & [[field](*field)=] & [[limits](*limits)=] & [[dimension_field](*dimension_field)=] & [[entity_field](*entity_field)=] & [[filter](*filter)=] & [[order_by](*order_by)=] & [[vat](*vat)=] & [[stat_type](*stat_type)=] & [[currency](*currency)=] & [[timezone](*timezone)=] ``` {% note info %} Можно получить статистику за произвольный интервал времени. Для этого укажите две даты (начало и окончание периода): ```no-highlight period=2014-06-29&period=2014-07-28 ``` {% endnote %} - lang [*](*a) : Язык ответа. Должен присутствовать во всех запросах. - pretty : Форматирует результат для удобства чтения. Допустимое значение: `pretty=1`. - period [*](*a) : Интервал времени, за который необходимо получить отчет. Допустимые значения: - `today` — статистика за сегодняшний день; - `yesterday` — статистика за вчерашний день; - `thismonth` — статистика за текущий месяц; - `lastmonth` — статистика за прошлый месяц; - `30days` — статистика за последние 30 дней (включая текущий день); - `90days` — статистика за последние 90 дней (включая текущий день); - `180days` — статистика за последние 180 дней (включая текущий день); - `365days` — статистика за последние 365 дней (включая текущий день); - `thisyear` — статистика за текущий год (включая текущий день). {% note info %} Можно получить статистику за произвольный интервал времени. Для этого укажите две даты (начало и окончание периода): ```no-highlight period=2014-06-29&period=2014-07-28 ``` {% endnote %} - field [*](*a) : Идентификатор поля, которое необходимо включить в отчет. Обычно это различные показатели, например, показы рекламы в блоках, запросы рекламы в блоках. Список таких полей выводится в структуре `fields`, ресурс [Дерево статистики](https://yandex.com/dev/partner-statistics/doc/ru/reference/statistics-tree2.md). {% note info %} Чтобы добавить в отчет несколько полей, укажите параметр несколько раз: ```no-highlight field=shows&field=hits ``` {% endnote %} - limits : Пагинация. Формат: ```no-highlight {"limit":50,"offset":0} ``` - dimension_field : Идентификатор поля, которое будет использоваться для группировки (например, группировка по дням или неделям). Список таких полей выводится в структуре `dimension_fields`, ресурс [Дерево статистики](https://yandex.com/dev/partner-statistics/doc/ru/reference/statistics-tree2.md). - entity_field : Идентификатор поля, которое будет использоваться для группировки по значениям этого поля в отчете (например, домен и название площадки). Список таких полей выводится в структуре `entity_fields`, ресурс [Дерево статистики](https://yandex.com/dev/partner-statistics/doc/ru/reference/statistics-tree2.md). {% note info %} Чтобы произвести группировку по нескольким полям, укажите идентификаторы полей следующим образом: ```no-highlight entity_field=domain&entity_field=page_id ``` {% endnote %} - filter : Фильтр для построения отчета. В качестве параметров фильтра используются поля из структуры `entity_filter_fields`, ресурс [Дерево статистики](https://yandex.com/dev/partner-statistics/doc/ru/reference/statistics-tree2.md). Подробнее о фильтрах в разделе [Поля-фильтры](https://yandex.com/dev/partner-statistics/doc/ru/reference/report.md#filters). - order_by : Сортировка результата. Формат: ```no-highlight [{"field":"date","dir":"asc"}] ``` В качестве значения параметра `field` можно добавлять идентификатор поля, которое будет использоваться для группировки (список таких полей выводится в структуре `dimension_fields`, ресурс [Дерево статистики](https://yandex.com/dev/partner-statistics/doc/ru/reference/statistics-tree2.md)). В качестве значения параметра `dir` можно использовать `asc/desc` — сортировка по возрастанию/убыванию. - vat : Включить или исключить НДС. - stat_type : Тип отчета. Допустимые значения: - `stat_type=mm` — отчет по Мобильной медиации; - `stat_type=dsp` — отчет по DSP; - `stat_type=ssp` — отчет по SSP; - `stat_type=main` — отчет по основной статистике. Значение по умолчанию. - currency : Валюта в отчете. Допустимые значения: - `USD` — доллары; - `EUR` — евро; - `RUB` — рубли. Значение по умолчанию. - timezone : Дополнительный параметр для получения статистики в нужном часовом поясе. По умолчанию статистика рассчитывается по времени Москвы (`Europe/Moscow`, UTC+03:00). {% note info %} При получении статистики с группировкой по дням границы суток рассчитываются с учетом указанного часового пояса. Например, при передаче часового пояса `Asia/Bishkek` (UTC+06:00) начало и конец суток будут сдвинуты на +3 часа относительно времени Москвы (`Europe/Moscow`, UTC+03:00), а статистика — рассчитана с учетом этого временного сдвига. Пример: ```json { "timezone": "Asia/Bishkek" } ``` {% endnote %} {% cut "Поддерживаемые значения `timezone`" %} | UTC | Значение `timezone` | | --------- | ------------------------ | | UTC-11:00 | `Pacific/Midway` | | UTC-10:00 | `Pacific/Honolulu` | | UTC-09:00 | `Pacific/Gambier` | | UTC-09:30 | `Pacific/Marquesas` | | UTC-08:00 | `Pacific/Pitcairn` | | UTC-07:00 | `America/Creston` | | UTC-06:00 | `America/Bahia_Banderas` | | UTC-05:00 | `America/Bogota` | | UTC-04:00 | `America/Anguilla` | | UTC-03:00 | `America/Araguaina` | | UTC-03:30 | `America/St_Johns` | | UTC-02:00 | `America/Noronha` | | UTC-01:00 | `Atlantic/Azores` | | UTC±00:00 | `America/Danmarkshavn` | | UTC+01:00 | `Africa/Tunis` | | UTC+02:00 | `Europe/Kaliningrad` | | UTC+03:00 | `Europe/Moscow` | | UTC+03:30 | `Asia/Tehran` | | UTC+04:00 | `Europe/Astrakhan` | | UTC+04:30 | `Asia/Kabul` | | UTC+05:00 | `Asia/Aqtau` | | UTC+05:30 | `Asia/Calcutta` | | UTC+05:45 | `Asia/Katmandu` | | UTC+06:00 | `Asia/Bishkek` | | UTC+06:30 | `Asia/Rangoon` | | UTC+07:00 | `Asia/Bangkok` | | UTC+08:00 | `Asia/Brunei` | | UTC+08:45 | `Australia/Eucla` | | UTC+09:00 | `Asia/Chita` | | UTC+09:30 | `Australia/Darwin` | | UTC+10:00 | `Asia/Ust-Nera` | | UTC+10:30 | `Australia/Adelaide` | | UTC+11:00 | `Asia/Magadan` | | UTC+12:00 | `Asia/Anadyr` | | UTC+13:00 | `Pacific/Apia` | | UTC+13:45 | `Pacific/Chatham` | | UTC+14:00 | `Pacific/Kiritimati` | {% endcut %} \* Обязательный параметр. ## Заголовки запроса {#headers} **Заголовок** | **Описание** | **Обязательный** ----- | ----- | ----- `Authorization` | Авторизационный токен пользователя. | Да Общая структура ответа приведена ниже. Порядок следования элементов не гарантируется. ## Формат ответа JSON {#output-JSON} ```json { "data" : { "currencies" : [ { "code" : {string}, "id" : {string} }, { ... } ], "dimensions" : { "field_name" : {string} }, "is_last_page" : {boolean}, "measures" : { "field_name" : {string} }, "periods" : [ [ {string}, {string} ] ], "points" : [ { "dimensions" : { "field_name" : {string} }, "measures" : [ { ... } ] } ], "report_title" : {string}, "totals" : { "2" : [ { ... } ] } }, "result" : {string} } ``` ## Параметры ответа {#spec-output} - data : Дерево статистики. - currencies : Описание валют. - code : Код валюты. - id : Идентификатор валюты. - totals : Объекты с итоговыми данными в отчете. В каждом объекте находится поле с идентификатором валюты и список значений, например, количество кликов и показов. - is_last_page : Признак, который указывает является ли текущая страница последней (используется для пагинации). Допустимые значения: - `false` — страница не последняя; - `true` — страница последняя. - points : Массив объектов с данными. - measures : Поля, перечисленные в запросе. - dimensions : Поля, по которым сгруппирован отчет. - dimensions : Описание полей, по которым сгруппирован отчет. - report_title : Название отчета. - result : Результат выполнения метода. Допустимые значения: - `ok` — вызов метода прошел успешно; - `error` — при вызове метода произошла ошибка. ## Пример для JSON {#example-JSON} > Запрос: > > ```no-highlight > curl -i -g -H 'Authorization: OAuth 123qwe456a...' \ > -X GET 'https://partner.yandex.ru/api/statistics2/get.json? \ > lang=ru \ > &pretty=1 \ > &dimension_field=date|day \ > &period=thismonth \ > &entity_field=page_level \ > &field=shows \ > &field=hits_render \ > &field=hits \ > &filter=["page_id","=","458472"] \ > &field=fillrate' \ > ``` > > Ответ: > > ```json > HTTP/1.1 200 OK > Server: nginx > Date: Wed, 16 Dec 2020 10:40:13 GMT > Content-Type: application/json; charset=UTF-8 > Transfer-Encoding: chunked > Connection: keep-alive > > { > "data" : { > "currencies" : [ > { > "code" : "USD", > "id" : "1" > }, > { > "code" : "RUB", > "id" : "2" > }, > { > "code" : "EUR", > "id" : "3" > } > ], > "dimensions" : { > "date" : { > "index" : 1, > "title" : "Дата", > "type" : "date" > }, > "page_level" : { > "index" : 2, > "title" : "Уровень продукта", > "type" : "categories" > } > }, > "is_last_page" : true, > "measures" : { > "fillrate" : { > "index" : 6, > "title" : "Fill rate блоков с учетом проверки видимости", > "type" : "percent", > "unit" : "percent" > }, > "hits" : { > "index" : 5, > "title" : "Запросы рекламы в блоках", > "type" : "number", > "unit" : "count" > }, > "hits_render" : { > "index" : 4, > "title" : "Отрисовки рекламы в блоках", > "type" : "number", > "unit" : "count" > }, > "shows" : { > "index" : 3, > "title" : "Показы рекламы в блоках", > "type" : "number", > "unit" : "count" > } > }, > "periods" : [ > [ > "2020-12-01", > "2020-12-15" > ] > ], > "points" : [ > { > "dimensions" : { > "date" : [ > "2020-12-15" > ], > "page_level" : "Тематические площадки" > }, > "measures" : [ > { > "fillrate" : 50, > "hits" : 2, > "hits_render" : 2, > "shows" : 1 > } > ] > }, > { > "dimensions" : { > "date" : [ > "2020-12-02" > ], > "page_level" : "Тематические площадки" > }, > "measures" : [ > { > "fillrate" : 0, > "hits" : 0, > "hits_render" : 0, > "shows" : 0 > } > ] > }, > { > "dimensions" : { > "date" : [ > "2020-12-11" > ], > "page_level" : "Тематические площадки" > }, > "measures" : [ > { > "fillrate" : 16.9291338582677, > "hits" : 254, > "hits_render" : 254, > "shows" : 43 > } > ] > }, > { > "dimensions" : { > "date" : [ > "2020-12-14" > ], > "page_level" : "Тематические площадки" > }, > "measures" : [ > { > "fillrate" : 0, > "hits" : 0, > "hits_render" : 0, > "shows" : 0 > } > ] > }, > { > "dimensions" : { > "date" : [ > "2020-12-08" > ], > "page_level" : "Тематические площадки" > }, > "measures" : [ > { > "fillrate" : 0, > "hits" : 0, > "hits_render" : 0, > "shows" : 0 > } > ] > } > ], > "report_title" : "Отчет за период 01.12.2020 - 15.12.2020", > "total_rows" : 5, > "totals" : { > "2" : [ > { > "fillrate" : 17.1875, > "hits" : 256, > "hits_render" : 256, > "shows" : 44 > } > ] > } > }, > "result" : "ok" > } > > ``` [*lang]: Язык ответа. Должен присутствовать во всех запросах. [*pretty]: Форматирует результат для удобства чтения. Допустимое значение: `pretty=1`. [*period]: Интервал времени, за который необходимо получить отчет. Допустимые значения:   - `today` — статистика за сегодняшний день; - `yesterday` — статистика за вчерашний день; - `thismonth` — статистика за текущий месяц; - `lastmonth` — статистика за прошлый месяц; - `30days` — статистика за последние 30 дней (включая текущий день); - `90days` — статистика за последние 90 дней (включая текущий день); - `180days` — статистика за последние 180 дней (включая текущий день); - `365days` — статистика за последние 365 дней (включая текущий день); - `thisyear` — статистика за текущий год (включая текущий день). [*field]: Идентификатор поля, которое необходимо включить в отчет. Обычно это различные показатели, например, показы рекламы в блоках, запросы рекламы в блоках. Список таких полей выводится в структуре `fields`, ресурс [Дерево статистики](https://yandex.com/dev/partner-statistics/doc/ru/reference/statistics-tree2.md). {% note info %} Чтобы добавить в отчет несколько полей, укажите параметр несколько раз:   ```no-highlight field=shows&field=hits ``` {% endnote %} [*limits]: Пагинация. Формат:   ```no-highlight {"limit":50,"offset":0} ``` [*dimension_field]: Идентификатор поля, которое будет использоваться для группировки (например, группировка по дням или неделям). Список таких полей выводится в структуре `dimension_fields`, ресурс [Дерево статистики](https://yandex.com/dev/partner-statistics/doc/ru/reference/statistics-tree2.md). [*entity_field]: Идентификатор поля, которое будет использоваться для группировки по значениям этого поля в отчете (например, домен и название площадки). Список таких полей выводится в структуре `entity_fields`, ресурс [Дерево статистики](https://yandex.com/dev/partner-statistics/doc/ru/reference/statistics-tree2.md). {% note info %} Чтобы произвести группировку по нескольким полям, укажите идентификаторы полей следующим образом: ```no-highlight entity_field=domain&entity_field=page_id ``` {% endnote %} [*filter]: Фильтр для построения отчета. В качестве параметров фильтра используются поля из структуры `entity_filter_fields`, ресурс [Дерево статистики](https://yandex.com/dev/partner-statistics/doc/ru/reference/statistics-tree2.md). Подробнее о фильтрах в разделе [Поля-фильтры](https://yandex.com/dev/partner-statistics/doc/ru/reference/report.md#filters). [*order_by]: Сортировка результата. Формат:   ```no-highlight [{"field":"date","dir":"asc"}] ```   В качестве значения параметра `field` можно добавлять идентификатор поля, которое будет использоваться для группировки (список таких полей выводится в структуре `dimension_fields`, ресурс [Дерево статистики](https://yandex.com/dev/partner-statistics/doc/ru/reference/statistics-tree2.md)). В качестве значения параметра `dir` можно использовать `asc/desc` — сортировка по возрастанию/убыванию. [*vat]: Включить или исключить НДС. [*stat_type]: Тип отчета. Допустимые значения:   - `stat_type=mm` — отчет по Мобильной медиации; - `stat_type=dsp` — отчет по DSP; - `stat_type=ssp` — отчет по SSP; - `stat_type=main` — отчет по основной статистике. Значение по умолчанию. [*currency]: Валюта в отчете. Допустимые значения:   - `USD` — доллары; - `EUR` — евро; - `RUB` — рубли. Значение по умолчанию. [*a]: Обязательный параметр. [*timezone]: Дополнительный параметр для получения статистики в нужном часовом поясе. По умолчанию статистика рассчитывается по времени Москвы (`Europe/Moscow`, UTC+03:00).