Examples

The examples provided below are helpful for solving common tasks.

These requests do not define the date1 and date2 parameters (the dates of the beginning and end of the report period). By default, the report period is 7 days (including the current day).

A demo tag is used as the id parameter.

The /stat/v1/data method is used for generating requests.

Note

The request language (lang parameter) affects the filter values. Use the lang=ru parameter when using Russian names, for example, ym:s:regionCityName=='Saint Petersburg'.

Presets

Sources, summary report

preset=sources_summary

https://api-metrica.yandex.net/stat/v1/data?preset=sources_summary&id=44147844

“Sources, summary” report. Users from Saint Petersburg

preset=sources_summary

filters=ym:s:regionCityName=='Санкт-Петербург'

The report data is a segmented using the parameter filters=ym:s:regionCityName=='Санкт-Петербург'.

https://api-metrica.yandex.net/stat/v1/data?preset=sources_summary&filters=ym:s:regionCityName=='Санкт-Петербург'&id=44147844&lang=ru

“Search queries” report

preset=sources_search_phrases

https://api-metrica.yandex.net/stat/v1/data?preset=sources_search_phrases&id=44147844

“Browsers” report

preset=tech_platforms

dimensions=ym:s:browser

This preset helps create a report on user browsers, without accounting for the browser version.

https://api-metrica.yandex.net/stat/v1/data?preset=tech_platforms&dimensions=ym:s:browser&id=44147844

Where the dimensions=ym:s:browser parameter sets a dimension in the preset for grouping resulting data.

Content analytics

Traffic sources

You can use the preset to generate a report on the sources from which users were taken to the website's articles.

preset=publishers_sources

https://api-metrica.yandex.net/stat/v1/data?preset=publishers_sources&id=44147844&date1=today&date2=today

Categories

Use this preset to generate a report with overall statistics by category.

preset=publishers_rubrics

https://api-metrica.yandex.net/stat/v1/data?preset=publishers_rubrics&id=44147844&date1=today&date2=today

Authors

Use this preset to generate a standard report with statistics on the authors of your website's articles.

preset=publishers_authors

https://api-metrica.yandex.net/stat/v1/data?preset=publishers_authors&id=44147844&date1=today&date2=today

Topics

Use this preset to generate a standard report on the topics of the website's articles.

publishers_thematics

https://api-metrica.yandex.net/stat/v1/data?publishers_thematics&id=44147844&date1=today&date2=today

Segmentation

Types of traffic sources

dimensions=ym:s:lastTrafficSource

metrics=ym:s:visits,ym:s:users

filters=ym:s:lastTrafficSource=.('organic','direct','referral')

https://api-metrica.yandex.net/stat/v1/data?dimensions=ym:s:lastTrafficSource&metrics=ym:s:visits,ym:s:users&filters=ym:s:lastTrafficSource=.('organic','direct','referral')&id=44147844&lang=ru

Number of sessions and users from search engines

dimensions=ym:s:searchEngine

metrics=ym:s:visits,ym:s:users

filters=ym:s:trafficSource=='organic'

https://api-metrica.yandex.net/stat/v1/data?dimensions=ym:s:searchEngine&metrics=ym:s:visits,ym:s:users&filters=ym:s:trafficSource=='organic'&id=44147844

Number of sessions and users from search engines without robot sessions

Yandex Metrica identifies robots based on behavioral factors and other technical signals. Filtering robots in Yandex Metrica reports helps you get accurate data. For example, bounce rate, time on site, and page depth. To learn more, see Help.

dimensions=ym:s:searchEngine

metrics=ym:s:visits,ym:s:users

filters=ym:s:trafficSource=='organic' AND ym:s:isRobot=='No'

https://api-metrica.yandex.net/stat/v1/data?dimensions=ym:s:searchEngine&metrics=ym:s:visits,ym:s:users&filters=ym:s:trafficSource=='organic' AND ym:s:isRobot=='No'&id=44147844

Number of sessions and new users from search engines

dimensions=ym:s:searchEngine

metrics=ym:s:visits,ym:s:users

filters=ym:s:trafficSource=='organic' AND ym:s:isNewUser=='Yes'

https://api-metrica.yandex.net/stat/v1/data?dimensions=ym:s:searchEngine&metrics=ym:s:visits,ym:s:users&filters=ym:s:trafficSource=='organic' AND ym:s:isNewUser=='Yes'&id=44147844

Number of sessions and users accounting for the selected region

metrics=ym:s:visits,ym:s:users

filters=ym:s:regionCityName=.('Moscow','Saint Petersburg')

https://api-metrica.yandex.net/stat/v1/data?metrics=ym:s:visits,ym:s:users&filters=ym:s:regionCityName=.('Москва','Санкт-Петербург')&id=44147844&lang=ru

https://api-metrica.yandex.net/stat/v1/data?metrics=ym:s:visits,ym:s:users&filters=ym:s:regionCityName=.('Moscow','Saint Petersburg')&id=44147844

Number of sessions with depth greater than 5 pages

metrics=ym:s:visits

filters=ym:s:pageViews>5

https://api-metrica.yandex.net/stat/v1/data?metrics=ym:s:visits&filters=ym:s:pageViews>5&id=44147844

Dimensions and metrics

Number of sessions

metrics=ym:s:visits

https://api-metrica.yandex.net/stat/v1/data?metrics=ym:s:visits&id=44147844

Number of users and conversion rate for a specified goal

This example features parameterization of the metric ym:s:goal<goal_id>conversionRate with a goal ID.

metrics=ym:s:users,ym:s:goal<goal_id>conversionRate

dimensions=ym:s:trafficSource

goal_id=<goal ID>

The report will include the number of users who reached the specified goal. Data will be grouped by traffic source.

https://api-metrica.yandex.net/stat/v1/data?dimensions=ym:s:trafficSource&metrics=ym:s:users,ym:s:goal%3Cgoal_id%3EconversionRate&goal_id=30606879&id=44147844

Conversion for multiple goals

This example features parameterization of the metric ym:s:goal<goal_id>conversionRate with a goal ID in the expression body.

metrics=ym:s:users,ym:s:goal<идентификатор первой цели>conversionRate,ym:s:goal<идентификатор второй цели>conversionRate

https://api-metrica.yandex.net/stat/v1/data?metrics=ym:s:users,ym:s:goal30606879conversionRate,ym:s:goal30606884conversionRate&id=44147844

Segment report for an experiment in Yandex Direct

This example features parameterization of the dimension ym:s:experimentAB<experiment_ab>.

metrics=ym:s:bounceRate

dimensions=ym:s:experimentAB123, where 123 is the experiment ID.

https://api-metrica.yandex.net/stat/v1/data?id=44147844;&metrics=ym:s:bounceRate&dimensions=ym:s:experimentAB123

Content analytics. Article report

Report on the number of article viewed on the website. The data is grouped by article.

dimensions=ym:s:publisherArticle

metrics=ym:s:publisherviews

filters=(ym:s:publisherArticle!n)

sort=-ym:s:publisherviews

https://api-metrica.yandex.net/stat/v1/data?ids=44147844&date1=2019-10-01&date2=2019-10-01&dimensions=ym:s:publisherArticle&metrics=ym:s:publisherviews&filters=(ym:s:publisherArticle!n)&sort=-ym:s:publisherviews

Displaying data by time

The /stat/v1/data/bytime method is used for getting data.

The examples below show how to get data for a specific period of time. This data can be grouped. To define the type or number of groups (dimensions), use the row_ids or top_keys parameter. If the row_ids parameter is omitted, the top_keys parameter is used automatically. By default, it is set to 7 (the maximum value is 30).

More information about parameters

row_ids — Array of arrays in JSON format. Each sub-array may contain dimension values (name or id) corresponding to the set of values defined in the request for the dimensions parameter. The size of a sub-array indicates the dimensions that data will be grouped by.

For example, if data is grouped by a single dimension, the size of this sub-array is 1.
```
...?row_ids=[["Russia"]]&...&dimensions=ym:s:regionCountryName,ym:s:regionAreaName,ym:s:regionCityName&...
```
Note
If a sub-array contains dimension values for a single group (for example, Geography), the data is grouped by the last specified dimension.
```
...?row_ids=[["Russia","Saratov region","Saratov"]]&...&dimensions=ym:s:regionCountryName,ym:s:regionAreaName,ym:s:regionCityName&...
```
To use multiple sub-arrays, separate them with commas:
```
...?row_ids=[["Russia"],["Russia","Saratov region"],["Russia","Saratov region","Saratov"]]&...&dimensions=ym:s:regionCountryName,ym:s:regionAreaName,ym:s:regionCityName&...
```
The top_keys parameter takes the first values from the dataset in the first dimension specified in the request. You can set the quantity of these values (30 maximum). Data is sorted in the API response by decreasing order of the first value of the metrics parameter.
```
...?top_keys=3&...&dimensions=ym:s:regionCountry,ym:s:regionArea,ym:s:regionCity&group=day&ids=44147844&metrics=ym:s:visits
```

Sources, summary report

In the example, the response will contain data grouped by the type of traffic source.

Example without the row_ids parameter. The top_keys parameter is used by default:

https://api-metrica.yandex.net/stat/v1/data/bytime?date1=2018-01-01&date2=2018-01-14&group=day&dimensions=ym:s:<attribution>TrafficSource&attribution=last&ids=44147844&metrics=ym:s:visits

Example with a value set for the top_keys parameter:

https://api-metrica.yandex.net/stat/v1/data/bytime?top_keys=3&date1=2018-01-01&date2=2018-01-14&group=day&dimensions=ym:s:<attribution>TrafficSource&attribution=last&ids=44147844&metrics=ym:s:visits

The examples below show reports that specify dimension values for the Sources group.

Traffic sources for the day:

https://api-metrica.yandex.net/stat/v1/data/bytime?row_ids=[["direct"],["organic","organic.yandex"],["social","social.ya"],["ad"]]&date1=2018-01-13&date2=2018-01-13&group=day&dimensions=ym:s:<attribution>TrafficSource,ym:s:<attribution>SourceEngine&attribution=last&ids=44147844&metrics=ym:s:visits

Traffic sources for two weeks, grouped by days:

https://api-metrica.yandex.net/stat/v1/data/bytime?row_ids=[["direct"],["organic","organic.yandex"],["social","social.ya"],["ad"]]&date1=2018-01-01&date2=2018-01-14&group=day&dimensions=ym:s:<attribution>TrafficSource,ym:s:<attribution>SourceEngine&attribution=last&ids=44147844&metrics=ym:s:visits

Traffic sources for two weeks, grouped by weeks. Data is grouped by calendar weeks:

https://api-metrica.yandex.net/stat/v1/data/bytime?row_ids=[["direct"],["organic","organic.yandex"],["social","social.ya"],["ad"]]&date1=2018-01-01&date2=2018-01-14&group=week&dimensions=ym:s:<attribution>TrafficSource,ym:s:<attribution>SourceEngine&attribution=last&ids=44147844&metrics=ym:s:visits

Users — Geography report

In this example, the report will contain data on the number of users, grouped by geographical location.

Example without the row_ids parameter. The top_keys parameter is used by default:

https://api-metrica.yandex.net/stat/v1/data/bytime?date1=2018-01-01&date2=2018-01-14&group=day&dimensions=ym:s:regionCountry,ym:s:regionArea,ym:s:regionCity&ids=44147844&metrics=ym%3As%3Avisits

Example with a value set for the top_keys parameter:

https://api-metrica.yandex.net/stat/v1/data/bytime?top_keys=3&date1=2018-01-01&date2=2018-01-14&group=day&dimensions=ym:s:regionCountry,ym:s:regionArea,ym:s:regionCity&ids=44147844&metrics=ym%3As%3Avisits

The examples below show reports that specify dimension values for the Geography group.

The number of sessions from Russia, the Saratovskaya region, and Saratov over two weeks. Data is grouped by calendar weeks:

https://api-metrica.yandex.net/stat/v1/data/bytime?row_ids=[["Russia"],["Russia","Саратовская%20область"],["Russia","Саратовская%20область","Saratov"]]&date1=2018-01-01&date2=2018-01-14&group=week&dimensions=ym:s:regionCountryName,ym:s:regionAreaName,ym:s:regionCityName&ids=44147844&metrics=ym%3As%3Avisits&lang=ru

https://api-metrica.yandex.net/stat/v1/data/bytime?row_ids=[["Russia"],["Russia","Saratovskaya%region"],["Russia","Saratovskaya%20region","Saratov"]]&date1=2018-01-01&date2=2018-01-14&group=week&dimensions=ym:s:regionCountryName,ym:s:regionAreaName,ym:s:regionCityName&ids=44147844&metrics=ym%3As%3Avisits

The number of sessions from Russia, Moscow and the Moscow region, Saint Petersburg, and the Leningradskaya region over two weeks:

https://api-metrica.yandex.net/stat/v1/data/bytime?row_ids=[["Russia"],["Russia","Москва%20и%20Московская область"],["Russia","Санкт-Петербург%20и%20Ленинградская%20область"]]&date1=2018-01-01&date2=2018-01-14&group=week&dimensions=ym:s:regionCountryName,ym:s:regionAreaName,ym:s:regionCityName&ids=44147844&metrics=ym%3As%3Avisits&lang=ru

https://api-metrica.yandex.net/stat/v1/data/bytime?row_ids=[["Russia"],["Russia","Moscow%20и%Moscow region"],["Russia","Saint Peteresburg%20и%20Leningradskaya region"]]&date1=2018-01-01&date2=2018-01-14&group=week&dimensions=ym:s:regionCountryName,ym:s:regionAreaName,ym:s:regionCityName&ids=44147844&metrics=ym%3As%3Avisits

Report on operating systems and browsers

In this example, the report will contain data on the number of users, grouped by the type of operating system they are using.

Example without the row_ids parameter. The top_keys parameter is used by default:

https://api-metrica.yandex.net/stat/v1/data/bytime?date1=2018-01-01&date2=2018-01-14&group=day&dimensions=ym:s:operatingSystemRootName,ym:s:browserName&ids=44147844&accuracy=medium&metrics=ym:s:visits

Example with a value set for the top_keys parameter:

https://api-metrica.yandex.net/stat/v1/data/bytime?top_keys=10&date1=2018-01-01&date2=2018-01-14&group=day&dimensions=ym:s:operatingSystemRootName,ym:s:browserName&ids=44147844&accuracy=medium&metrics=ym:s:visits

The examples below show reports that specify dimension values for the Operating systems and Browsers groups.

The number of sessions for users of Windows, Yandex Browser, and Internet Explorer. Data is grouped by day:

https://api-metrica.yandex.net/stat/v1/data/bytime?row_ids=[["Windows"],["Windows","Яндекс.Браузер"],["Windows","MSIE"]]&date1=2018-01-01&date2=2018-01-14&group=day&dimensions=ym:s:operatingSystemRootName,ym:s:browserName&ids=44147844&accuracy=medium&metrics=ym:s:visits&lang=ru

https://api-metrica.yandex.net/stat/v1/data/bytime?row_ids=[["Windows"],["Windows","Yandex.Browser"],["Windows","MSIE"]]&date1=2018-01-01&date2=2018-01-14&group=day&dimensions=ym:s:operatingSystemRootName,ym:s:browserName&ids=44147844&accuracy=medium&metrics=ym:s:visits

Data is grouped by calendar weeks:

https://api-metrica.yandex.net/stat/v1/data/bytime?row_ids=[["Windows"],["Windows","Яндекс.Браузер"],["Windows","MSIE"]]&date1=2018-01-01&date2=2018-01-14&group=week&dimensions=ym:s:operatingSystemRootName,ym:s:browserName&ids=44147844&accuracy=medium&metrics=ym:s:visits&lang=ru

https://api-metrica.yandex.net/stat/v1/data/bytime?row_ids=[["Windows"],["Windows","Yandex.Browser"],["Windows","MSIE"]]&date1=2018-01-01&date2=2018-01-14&group=week&dimensions=ym:s:operatingSystemRootName,ym:s:browserName&ids=44147844&accuracy=medium&metrics=ym:s:visits

Number of pageviews per day for the last 30 days (chart)

In the example, data for creating a chart will be received. The /stat/v1/data/bytime method is used for getting data.

metrics=ym:s:hits

date1=30daysAgo

date2=today

group=day

https://api-metrica.yandex.net/stat/v1/data/bytime?metrics=ym:s:hits&date1=30daysAgo&date2=today&group=day&id=44147844

Comparing segments

The /stat/v1/data/comparison method is used for comparing data.

Comparing two days

In this example, the number of users is compared. Data is grouped by traffic source.

metrics=ym:s:users

dimensions=ym:s:trafficSource

date1_a=today

date1_b=yesterday

https://api-metrica.yandex.net/stat/v1/data/comparison?metrics=ym:s:users&dimensions=ym:s:trafficSource&date1_a=today&date1_b=yesterday&id=44147844

Comparing sessions from mobile and non-mobile devices

In this example, the number of users and the bounce rate are compared. Data is grouped by traffic source.

metrics=ym:s:users,ym:s:bounceRate

dimensions=ym:s:trafficSource

filters_a=ym:s:isMobile=='Yes'

filters_b=ym:s:isMobile=='No'

https://api-metrica.yandex.net/stat/v1/data/comparison?metrics=ym:s:users,ym:s:bounceRate&dimensions=ym:s:trafficSource&filters_a=ym:s:isMobile=='Yes'&filters_b=ym:s:isMobile=='No'

Drilldown

The /stat/v1/data/drilldown method is used for getting data.

“Operating systems” report in tree view

To generate the “Operating systems” report in tree view, you need to:

Send a request for getting top-level data, using the tech_platforms preset (the Operating systems report).
```
https://api-metrica.yandex.net/stat/v1/data/drilldown?preset=tech_platforms&id=44147844
```

In the response, the expand parameter has the value true. This means that the node can be expanded to the next level. In this case, we can get data about the operating system version.

...
{
    "dimension": {
        "id": "100",
        "name": "Windows"
    },
    "metrics": [
        21779,
        52056,
        17.7786,
        2.39019,
        182.664
    ],
    "expand": true
}
...

To do this, we will define the path to this level from the root in the parent_id parameter. Since the id element of the dimension parameter has the value "100", the request will look like this:

https://api-metrica.yandex.net/stat/v1/data/drilldown?preset=tech_platforms&id=44147844&parent_id=["100"]

In the response, the expand parameter has the value false. In other words, this node cannot be expanded further.

...
{
    "dimension": {
        "id": "33",
        "name": "Windows 7 or 2008 Server"
    },
    "metrics": [
        14948,
        36300,
        7214,
        42842,
        048
    ],
    "expand": false
}
...

Was the article helpful?

Previous

Next

Yandex Direct — costs