Отчет по статистике

Строит отчет по выбранному уровню статистики за указанный период.

Формат запроса

https://partner2.yandex.ru/api/statistics2/get
 ? lang=<string>
 & [pretty=<integer>]
 & [period=<string>]
 & [field=<string>]
 & [limits=<string>]
 & [dimension_field=<string|string>]
 & [entity_field=<string>]
 & [filter=<string>]
 & [order_by=<string>]
 & [vat=<boolean>]
 & [stat_type=<string>]
 & [currency=<string>]

Примечание

Можно получить статистику за произвольный интервал времени. Для этого укажите две даты (начало и окончание периода):

period=2014-06-29&period=2014-07-28
  • lang *
    Язык ответа. Должен присутствовать во всех запросах.
  • pretty
    Форматирует результат для удобства чтения. Допустимое значение: pretty=1.
  • period *

    Интервал времени, за который необходимо получить отчет. Допустимые значения:

    • today — статистика за сегодняшний день;
    • yesterday — статистика за вчерашний день;
    • thismonth — статистика за текущий месяц;
    • lastmonth — статистика за прошлый месяц;
    • 30days — статистика за последние 30 дней (включая текущий день);
    • 90days — статистика за последние 90 дней (включая текущий день);
    • 180days — статистика за последние 180 дней (включая текущий день);
    • 365days — статистика за последние 365 дней (включая текущий день);
    • thisyear — статистика за текущий год (включая текущий день).

    Примечание

    Можно получить статистику за произвольный интервал времени. Для этого укажите две даты (начало и окончание периода):

    period=2014-06-29&period=2014-07-28
  • field *

    Идентификатор поля, которое необходимо включить в отчет. Обычно это различные показатели, например, показы рекламы в блоках, запросы рекламы в блоках. Список таких полей выводится в структуре fields, ресурс Дерево статистики.

    Примечание

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

    field=shows&field=hits
  • limits

    Пагинация. Формат:

    {"limit":50,"offset":0}
  • dimension_field
    Идентификатор поля, которое будет использоваться для группировки (например, группировка по дням или неделям). Список таких полей выводится в структуре dimension_fields, ресурс Дерево статистики.
  • entity_field

    Идентификатор поля, которое будет использоваться для группировки по значениям этого поля в отчете (например, домен и название площадки). Список таких полей выводится в структуре entity_fields, ресурс Дерево статистики.

    Примечание

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

    entity_field=domain&entity_field=page_id
  • filter
    Фильтр для построения отчета. В качестве параметров фильтра используются поля из структуры entity_filter_fields, ресурс Дерево статистики. Подробнее о фильтрах в разделе Поля-фильтры.
  • order_by

    Сортировка результата. Формат:

    [{"field":"date","dir":"asc"}]

    В качестве значения параметра field можно добавлять идентификатор поля, которое будет использоваться для группировки (список таких полей выводится в структуре dimension_fields, ресурс Дерево статистики). В качестве значения параметра dir можно использовать asc/desc — сортировка по возрастанию/убыванию.

  • vat
    Включить или исключить НДС.
  • stat_type

    Тип отчета. Допустимые значения:

    • stat_type=mm — отчет по Мобильной медиации;
    • stat_type=dsp — отчет по DSP;
    • stat_type=main — отчет по основной статистике. Значение по умолчанию.
  • currency

    Валюта в отчете. Допустимые значения:

    • USD — доллары;
    • EUR — евро;
    • RUB — рубли. Значение по умолчанию.

* Обязательный параметр.

Заголовки запроса

Заголовок Описание Обязательный
Authorization Авторизационный токен пользователя. Да

Общая структура ответа приведена ниже. Порядок следования элементов не гарантируется.

Формат ответа 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}
}

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

  • data
    Дерево статистики.
    • currencies
      Описание валют.
      • code
        Код валюты.
      • id
        Идентификатор валюты.
    • totals
      Объекты с итоговыми данными в отчете. В каждом объекте находится поле с идентификатором валюты и список значений, например, количество кликов и показов.
    • is_last_page
      Признак, который указывает является ли текущая страница последней (используется для пагинации). Допустимые значения:
      • false — страница не последняя;
      • true — страница последняя.
    • points
      Массив объектов с данными.
      • measures
        Поля, перечисленные в запросе.
      • dimensions
        Поля, по которым сгруппирован отчет.
    • dimensions
      Описание полей, по которым сгруппирован отчет.
    • report_title
      Название отчета.
  • result
    Результат выполнения метода. Допустимые значения:
    • ok — вызов метода прошел успешно;
    • error — при вызове метода произошла ошибка.

Пример для JSON

Запрос:

curl -i -g -H 'Authorization: OAuth 123qwe456a...' \
-X GET 'https://partner2.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' \

Ответ:

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"
}
Предыдущая
Дерево статистики
Следующая
API для in-app рекламыβ
В этой статье: