Localization and interpretation of dimension values

Attention.

Access tokens will not be accepted in URL parameters starting February 13, 2019. To continue working with the Yandex.Metrica API, set up authorization by passing the token in the HTTP header.

The outdated authorization method will be temporarily disabled on January 23, January 30, and February 6 for maintenance. Authorization using URL parameters will be unavailable on these dates.

The values of some dimensions may be given as an identifier, or as a text key. Text keys are localized, meaning they are translated to the language that is currently selected in the API.

To find out which dimensions support interpreting IDs, see the Description column. For these dimensions, the API returns the id key, which is the ID of this dimension's value, and the name key, which is a description of the value in the request language.

When filtering and using drill down, you should use the IDs for these dimensions.

You can control the request language using the lang parameter, which is accepted by all API methods, or by selecting the top-level domain to access the API.

Example

Let's look at the following request:

...
{
    "dimensions": [
        {
            "id": "organic",
            "name": "Search engine traffic"
        }
    ],
    "metrics": [
        ...
    ]
}
...

where

  • id is the ID of the value ym:s:<attribution>TrafficSource.

  • name is its text key.

For filtering the report on search engines, you can use the following syntax: filters=ym:s:<attribution>TrafficSource=='organic'.