Документация
Справочник разработчика
API управления
Управление клиентами Директа
API отчетов v1
Группировки
Клики
Параметры посетителей

Примеры

Ниже приведены примеры, которые позволяют решать часто встречающиеся задачи.

В данных запросах не указаны параметры date1 и date2 (даты начала и конца отчетного периода). По умолчанию количество дней отчетного периода равно 7 (включая текущий день).

В качестве параметров id и oauth_token представлены демонстрационные значения.

Для формирования запросов используется метод /stat/v1/data.

Краткое содержание

Шаблоны

Отчет "Источники - Сводка"

preset=sources_summary

Отчет "Источники - Сводка". Посетители из Санкт-Петербурга

preset=sources_summary

filters=ym:s:regionCityName=='Санкт-Петербург'

Данные отчета сегментированы с помощью параметра filters=ym:s:regionCityName=='Санкт-Петербург'.

Отчет "Источники - Поисковые фразы"

preset=sources_search_phrases

Отчет "Технологии - Браузеры"

preset=tech_platforms

dimensions=ym:s:browser

Данный шаблон помогает формировать отчет по браузеру, который используют посетители сайта, без учета версии браузера.

где параметр dimensions=ym:s:browser задает измерение в шаблоне, по которому группируются полученные данные.

Сегментация

Количество визитов и посетителей с учетом поисковых систем

dimensions=ym:s:searchEngine

metrics=ym:s:visits,ym:s:users

filters=ym:s:trafficSource=='organic'

Количество визитов и новых посетителей с учетом поисковых систем

dimensions=ym:s:searchEngine

metrics=ym:s:visits,ym:s:users

filters=ym:s:trafficSource=='organic' AND ym:s:isNewUser=='Yes'

Количество визитов и посетителей с учетом заданного региона

dimension=ym:s:regionCityName=.('Москва','Санкт-Петербург')

metrics=ym:s:visits,ym:s:users

Количество визитов с глубиной просмотра больше 5 страниц

metrics=ym:s:visits

filters=ym:s:pageViews>5

Отчет "Источники - Поисковые фразы"

Пример помогает сформировать отчет с учетом пользователей, которые посетили указанную в запросе страницу. В данном запросе URL-адрес страницы содержит заданный id.

Чтобы задать id в параметре filters, необходимо использовать регулярное выражение: .*/id[0-9]+/.*

preset=sources_search_phrases

filters=ym:pv:URL=~'.*/id[0-9]+/.*'

Группировки и метрики

Количество визитов

metrics=ym:s:visits

Количество пользователей и конверсия по указанной цели

В данном примере используется параметризация метрики ym:s:goal<goal_id>conversionRate идентификатором цели:

metrics=ym:s:users,ym:s:goal<goal_id>conversionRate

dimensions=ym:s:trafficSource

goal_id=<идентификатор цели>

В отчете будет получено количество пользователей, достигших указанную цель. Данные будут сгруппированы по источнику трафика.

Конверсия по нескольким целям

В данном примере используется параметризация метрики ym:s:goal<goal_id>conversionRate идентификатором цели в теле выражения.

metrics=ym:s:users,ym:s:goal<идентификатор первой цели>conversionRate,ym:s:goal<идентификатор второй цели>conversionRate

Запросы к API. Отображение данных по времени

Для получения данных используется метод /stat/v1/data/bytime.

Ниже приведены примеры получения данных за определенный период времени. Эти данные могут быть сгруппированы. Чтобы указать тип или количество группировок (dimensions), используйте параметры row_ids или top_keys. Если параметр row_ids не указан, автоматически используется параметр top_keys. По умолчанию он принимает значение 7 (максимальное — 30).

Подробно о параметрах
  • row_ids — массив массивов в формате JSON. Каждый подмассив может содержать значения измерений (name или id) соответственно заданному в запросе набору значений параметра dimensions. Длина подмассива указывает на измерения, по которым будут сгруппированы данные.

    Например, данные сгруппированы по одному измерению — длина этого подмассива равна 1.

    ...?row_ids=[["Россия"]]&...&dimensions=ym:s:regionCountryName,ym:s:regionAreaName,ym:s:regionCityName&...
    Примечание. 

    Если подмассив содержит значения измерений одной группы (например, География), то данные будут сгруппированы по последнему указанному измерению.

    ...?row_ids=[["Россия","Саратовская область","Саратов"]]&...&dimensions=ym:s:regionCountryName,ym:s:regionAreaName,ym:s:regionCityName&...

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

    ...?row_ids=[["Россия"],["Россия","Саратовская область"],["Россия","Саратовская область","Саратов"]]&...&dimensions=ym:s:regionCountryName,ym:s:regionAreaName,ym:s:regionCityName&...
  • Параметр top_keys выбирает первые значения из набора данных первого измерения, указанного в запросе. Вы можете задать количество этих значений (максимум 30). Сортировка данных в ответе API производится по убыванию первого значения параметра metrics.

    ...?top_keys=3&...&dimensions=ym:s:regionCountry,ym:s:regionArea,ym:s:regionCity&group=day&ids=2138128&metrics=ym:s:visits

Отчет "Источники - Сводка"

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

Пример без указания параметра row_ids, используется параметр top_keys по умолчанию:

Пример с указанием значения параметра top_keys:

Ниже представлены примеры отчетов с указанием значений измерений группы Источники.

Источники трафика за день:

Источники трафика за две недели с группировкой по дням:

Источники трафика за две недели с группировкой по неделям. При этом данные группируются по календарным неделям:

Отчет "Посетители - География"

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

Пример без указания параметра row_ids, используется параметр top_keys по умолчанию:

Пример с указанием значения параметра top_keys:

Ниже представлены примеры отчетов с указанием значений измерений группы География.

Количество визитов из России, Саратовской области и Саратова за две недели. Группировка производится по календарным неделям:

Количество визитов из России, Москвы и Московской области, Санкт-Петербурга и Ленинградской области за две недели:

Отчет по операционным системам и браузерам

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

Пример без указания параметра row_ids, используется параметр top_keys по умолчанию:

Пример с указанием значения параметра top_keys:

Ниже представлены примеры отчетов с указанием значений измерений групп Операционные системы и Браузеры.

Количество визитов пользователей ОС Windows, Яндекс.Браузера и Internet Explorer. Данные сгруппированы по дням:

Данные сгруппированы по календарным неделям:

Количество хитов по дням за последние 30 дней

В примере будут получены данные для построения графика. Для получения данных используется метод /stat/v1/data/bytime.

metrics=ym:s:hits

date1=30daysAgo

date2=today

group=day

Запросы к API. Сравнение сегментов

Для сравнения данных используется метод /stat/v1/data/comparison.

Сравнение двух недель

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

metrics=ym:s:users

dimensions=ym:s:trafficSource

date1_left=2014-01-06

date2_left=2014-01-12

date1_right=2014-02-13

date2_right=2014-02-19

Сравнение визитов с мобильных и не мобильных устройств

В данном примере сравниваются количество посетителей и доля отказов. Данные сгруппированы по источнику трафика.

metrics=ym:s:users,ym:s:bounceRate

dimensions=ym:s:trafficSource

filters_left=ym:s:isMobile=='Yes'

filters_right=ym:s:isMobile=='No'

Запросы к API. Drilldown

Отчет "Технологии-Операционные системы" в виде дерева

Чтобы сформировать отчет Операционные системы в виде дерева, необходимо:

  1. Отправить запрос для получения данных первого уровня, с помощью шаблона tech_platforms (отчет Операционные системы).

  2. В полученном ответе параметр expand имеет значение true. Это означает, что данный узел можно развернуть на следующий уровень. В нашем случаем можно получить данные о версии операционной системы.

    ...
    {
        "dimension": {
            "id": "100",
            "name": "Windows"
        },
        "metrics": [
            21779,
            52056,
            17.7786,
            2.39019,
            182.664
        ],
        "expand": true
    }
    ...

    Чтобы это сделать, укажем в параметре parent_id путь уровня от корня. Так как элемент id параметра dimension имеет значение "100", запрос будет выглядеть следующим образом:

    В полученном ответе параметр expand имеет значение false. То есть развернуть данный узел дальше нельзя.

    ...
    {
    
        "dimension": {
            "id": "33",
            "name": "Windows 7 или 2008 Server"
        },
        "metrics": [
            14948,
            36300,
            7214,
            42842,
            048
        ],
        "expand": false
    
    }
    ...