Параметры запросов

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

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

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

• Чтобы сгруппировать пользователей по строковому атрибута пользователя: ym:u:customStringAttribute<profile_attribute_id>.

• Чтобы получить сумму значений параметра клиентских событий: ym:ce2:sumParamValues<param_value_path>.

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

Параметр	Название	Описание	Значение по умолчанию
profile_attribute_id	ID атрибута профиля	Идентификатор атрибутов профиля, создаваемых в настройках приложения.	Нет
url_parameter_key	Параметр URL	Имя параметра URL.	Нет
currency	Валюта	Некоторые группировки позволяют настраивать валюту. Возможные значения: RUB, USD, EUR, YND. Cм. также ISO-4217.	Нет
app_currency	Валюта приложения	Например, внутриигровые валюты в E-com приложениях.	Нет
param_value_path	Путь в JSON	Путь в JSON, где узлы разделены точкой. Например: stat.time_in_app. Используется в ряде метрик для работы со значенем узла для указанного пути.	Нет
inapp_revenue_type	Тип In-app Revenue	Например, one_time_purchase, subscription_started, subscription_renewed, subscription_cancelled. Актуальный для приложения список можно получить, запросив группировку ym:r:inappRevenueType.	Нет

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

• Чтобы задать разные значения параметров для разных выражений, указывайте параметр непосредственно в выражении. Например, ym:u:customStringAttribute1000.

• Чтобы задать один параметр для всех выражений, добавляйте параметр выражения в запрос в исходном виде. Например, ...&dimensions=ym:u:customStringAttribute<profile_attribute_id>&profile_attribute_id=1000&....

• Если нужно параметризировать группировки или метрики разными значениями параметров и эти параметры могут принимать произвольную строку, используйте фигурные скобки. Например, ym:ce2:sumParamValues{'duration.max'}.

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

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

Написать в службу поддержки Предложить улучшение для документации