Локализация и расшифровка значений группировок

Внимание.

Передача авторизационного токена в параметрах URL перестанет работать 13 февраля 2019 года. Чтобы продолжить работу с API Метрики, настройте авторизацию по токену в HTTP-заголовке.

23 января, 30 января и 6 февраля 2019 года запланировано профилактическое отключение устаревшего способа авторизации — в эти дни он будет временно отключен.

Значения некоторых группировок могут быть представлены как идентификатором, так и его текстовой расшифровкой. Текстовые расшифровки локализованы, то есть переводятся на текущий выбранный в API язык.

Группировки, поддерживающие расшифровку идентификаторов, можно определить по колонке Расшифровка в разделе Группировки. Для таких измерений API вернет ключ id — идентификатор значения данного измерения, и ключ name — расшифровка значения на языке запроса.

При фильтрации и работе с drill down для таких группировок используйте идентификаторы.

Управлять языком запроса можно с помощью параметра lang, принимаемого всеми методами API, или с помощью выбора домена верхнего уровня, по которому производится обращение в API.

Пример

Рассмотрим следующий запрос:

https://api-metrika.yandex.net/stat/v1/data?id=44147844&dimensions=ym:s:<attribution>TrafficSource&metrics=ym:s:visits
...
{
    "dimensions": [
        {
            "id": "organic",
            "name": "Переходы из поисковых систем"
        }
    ],
    "metrics": [
        ...
    ]
}
...

где

  • id — идентификатор значения ym:s:<attribution>TrafficSource;

  • name — расшифровка.

Для фильтрации отчета по поисковым системам можно использовать следующий синтаксис: filters=ym:s:<attribution>TrafficSource=='organic'.