Сегментация

Все методы API отчетов позволяют возвращать результаты, рассчитанные не только по всему сайту, но и по отдельному сегменту данных. Для задания сегмента используйте параметр filters.

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

Фильтры по измерениям будут применены к исходным (не сгруппированным) данным, фильтры по метрикам — уже к сгруппированным строкам результата.

Для задания фильтра в URL-адресе запроса необходимо использовать URL-кодирование.

  1. Формат фильтра
  2. Пример использования сегментации

Формат фильтра

attribute operator 'value'

где

  • attribute — группировка или метрика. Например, ym:ge:mobileDeviceModel или ym:ge:users.
  • operator — оператор фильтрации. Указывает какой тип фильтра будет применен. Например, ==.
  • value — значение для сравнения. В строке со значением должны быть экранированы символы ' и \ с помощью символа \.

При этом действует лимит: количество уникальных группировок и метрик — до 10, количество отдельных фильтров — до 20, длина строки в фильтре — до 2000 символов.

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

filters=ym:ge:regionCity=='Москва'

Для разных группировок доступны разные операторы фильтрации (например, см. столбец Типы соответствий в разделе Приложение).

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

&metrics=ym:ge:users&dimensions=ym:ge:age&filters=NOT(ym:ge:age!=18)
ym:ge:regionCity=='Москва' OR ym:ge:regionCity=='Санкт-Петербург'

А также задавайте приоритет с помощью круглых скобок:

(ym:ge:regionCity=='Москва' OR ym:ge:regionCity=='Санкт-Петербург') AND ym:ge:gender=='мужской'

Фильтры по измерениям и по метрикам можно комбинировать только на верхнем уровне (вне скобок) и только через оператор AND.

Примечание. Язык запроса (параметр lang) влияет на значения фильтров. Рекомендуем всегда указывать данный параметр.

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

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

dimensions=ym:ge:mobileDeviceModel

metrics=ym:ge:users

filters=ym:ge:regionCityName=='Москва'

curl -X GET \
  'https://api.appmetrica.yandex.ru/stat/v1/data?id=1111&metrics=ym:ge:users&dimensions=ym:ge:mobileDeviceModel&filters=ym:ge:regionCityName==%27Москва%27' \
  -H 'Authorization: OAuth 05dd3dd84ff948fdae2bc4fb91f13e22bb1f289ceef0037'
Скопировано

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