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

Параметризация

API отчетов поддерживает параметризацию группировок и метрик.

Параметризация — это механизм задания параметров для некоторых группировок и метрик.

Параметры указываются в угловых скобках <>. Например:

  • Чтобы сгруппировать визиты по времени, группировка ym:s:datePeriod<group> параметризовано параметром group (группировка).
  • Чтобы получить количество целевых визитов, метрика ym:s:visits параметризована следующим образом: ym:s:goal<goal_id>visits.

Существуют следующие параметры:

ПараметрНазваниеОписаниеЗначение по умолчанию
goal_id ЦельИдентификатор цели
group Группировка

Группировка по времени для некоторых группировок.

Возможные значения: day, week, month, quarter, year.

week
attribution Атрибуция трафика

Некоторые группировки позволяют настраивать атрибуцию трафика.

Возможные значения: first (первый источник), last (последний источник), lastsign (последний значимый источник).

last
currency Валюта

Некоторые группировки позволяют настраивать валюту.

Возможные значения: RUB, USD, EUR, YND (фишки). см. также ISO-4217

Зависит от настроек счетчика

Задать параметр в выражении можно двумя способами:

  • Задать параметр непосредственно в выражении (например, ym:s:goal12345IsReached) — позволяет задать разные значения параметров для разных выражений.
  • Добавить параметр выражения в запрос в исходном виде (например, ...&dimensions=ym:s:goal<goal_id>IsReached&goal_id=12345&...) — позволяет задать один параметр для всех выражений.

Вы можете использовать оба способа в запросе одновременно.

Посмотрите как используется параметризация группировок и метрик в примере.