Yandex Metrica API

https://yandex.ru/dev/metrika/en/
Admin
Yandex Metrica API provides comprehensive tools to manage tags, retrieve website traffic data,...
Tokens:8,631
Snippets:67
Trust Score:9.9
Update:1 week ago
Show doc for...
Tokens:
Raw
### Example request with mixed prefixes in filters

Source: https://yandex.ru/dev/metrika/en/stat

This example shows a request to the /stat/v1/data endpoint that generates a report on sessions and unique users from search engines for a specific page. It uses dimensions and metrics with the ym:s: prefix, and filters that combine ym:s: and ym:pv: prefixes, demonstrating that different prefixes can be used in filters.

```http
https://api-metrika.yandex.net/stat/v1/data?dimensions=ym:s:searchEngineName&metrics=ym:s:visits,ym:s:users&filters=ym:s:trafficSourceName=='Search engine traffic' AND ym:pv:URL=@'help'&id=44147844
```

--------------------------------

### API request URL for report data

Source: https://yandex.ru/dev/metrika/en/stat

Example API request to get a report on page depth grouped by OS type and version, using the specified metrics and dimensions.

```http
https://api-metrika.yandex.net/stat/v1/data.csv?id=44147844&metrics=ym:s:avgPageViews&dimensions=ym:s:operatingSystem&limit=5
```

--------------------------------

### GET /stat/v1/data/comparison

Source: https://yandex.ru/dev/metrika/en/stat

Generates a comparison of segments specified in the same request. Data is shown as a table.

```APIDOC
## GET /stat/v1/data/comparison

### Description
Generates a comparison of segments specified in the same request. Data is shown as a table.

### Method
GET

### Endpoint
/stat/v1/data/comparison

### Parameters
#### Query Parameters
- **dimensions** (string) - Required - Comma-separated list of dimensions to group data by. Must use the `ym:s:` or `ym:pv:` prefix.
- **metrics** (string) - Required - Comma-separated list of metrics to calculate. Must use the `ym:s:` or `ym:pv:` prefix.
- **filters** (string) - Optional - Filter expression to segment data. Can use a different prefix than the request and multiple sets.
- **id** (integer) - Required - The ID of the counter (or goal) to request data for.

### Request Example
```
https://api-metrika.yandex.net/stat/v1/data/comparison?dimensions=ym:s:searchEngineName&metrics=ym:s:visits,ym:s:users&filters=ym:s:trafficSourceName=='Search engine traffic' AND ym:pv:URL=@'help'&id=44147844
```

### Response
#### Success Response (200)
- **data** (array) - Array of report rows.
- **total_rows** (integer) - Total number of rows.
- **sampled** (boolean) - Whether the data is sampled.
- **sample_share** (number) - Share of sampled data.
- **sample_size** (integer) - Size of the sample.
- **totals** (array) - Totals for the requested metrics.
- **query** (object) - The query parameters used.

#### Response Example
```json
{
  "data": [
    {
      "dimensions": [
        {
          "id": "searchEngineName",
          "name": "Yandex"
        }
      ],
      "metrics": [
        12345,
        6789
      ]
    }
  ],
  "total_rows": 1,
  "sampled": false,
  "sample_share": 1,
  "sample_size": 12345,
  "totals": [
    12345,
    6789
  ],
  "query": {
    "dimensions": "ym:s:searchEngineName",
    "metrics": "ym:s:visits,ym:s:users",
    "filters": "ym:s:trafficSourceName=='Search engine traffic' AND ym:pv:URL=@'help'",
    "id": 44147844
  }
}
```
```

--------------------------------

### GET /stat/v1/data

Source: https://yandex.ru/dev/metrika/en/stat

Generates a report in table format. All report levels and metrics are shown as a table.

```APIDOC
## GET /stat/v1/data

### Description
Generates a report in table format. All report levels and metrics are shown as a table.

### Method
GET

### Endpoint
/stat/v1/data

### Parameters
#### Query Parameters
- **dimensions** (string) - Required - Comma-separated list of dimensions to group data by. Must use the `ym:s:` or `ym:pv:` prefix.
- **metrics** (string) - Required - Comma-separated list of metrics to calculate. Must use the `ym:s:` or `ym:pv:` prefix.
- **filters** (string) - Optional - Filter expression to segment data. Can use a different prefix than the request and multiple sets.
- **id** (integer) - Required - The ID of the counter (or goal) to request data for.

### Request Example
```
https://api-metrika.yandex.net/stat/v1/data?dimensions=ym:s:searchEngineName&metrics=ym:s:visits,ym:s:users&filters=ym:s:trafficSourceName=='Search engine traffic' AND ym:pv:URL=@'help'&id=44147844
```

### Response
#### Success Response (200)
- **data** (array) - Array of report rows.
- **total_rows** (integer) - Total number of rows.
- **sampled** (boolean) - Whether the data is sampled.
- **sample_share** (number) - Share of sampled data.
- **sample_size** (integer) - Size of the sample.
- **totals** (array) - Totals for the requested metrics.
- **query** (object) - The query parameters used.

#### Response Example
```json
{
  "data": [
    {
      "dimensions": [
        {
          "id": "searchEngineName",
          "name": "Yandex"
        }
      ],
      "metrics": [
        12345,
        6789
      ]
    }
  ],
  "total_rows": 1,
  "sampled": false,
  "sample_share": 1,
  "sample_size": 12345,
  "totals": [
    12345,
    6789
  ],
  "query": {
    "dimensions": "ym:s:searchEngineName",
    "metrics": "ym:s:visits,ym:s:users",
    "filters": "ym:s:trafficSourceName=='Search engine traffic' AND ym:pv:URL=@'help'",
    "id": 44147844
  }
}
```
```

--------------------------------

### GET /stat/v1/data/comparison/drilldown

Source: https://yandex.ru/dev/metrika/en/stat

Generates a comparison of segments specified in the same request. Data is shown in a tree-view report.

```APIDOC
## GET /stat/v1/data/comparison/drilldown

### Description
Generates a comparison of segments specified in the same request. Data is shown in a tree-view report.

### Method
GET

### Endpoint
/stat/v1/data/comparison/drilldown

### Parameters
#### Query Parameters
- **dimensions** (string) - Required - Comma-separated list of dimensions to group data by. Must use the `ym:s:` or `ym:pv:` prefix.
- **metrics** (string) - Required - Comma-separated list of metrics to calculate. Must use the `ym:s:` or `ym:pv:` prefix.
- **filters** (string) - Optional - Filter expression to segment data. Can use a different prefix than the request and multiple sets.
- **id** (integer) - Required - The ID of the counter (or goal) to request data for.

### Request Example
```
https://api-metrika.yandex.net/stat/v1/data/comparison/drilldown?dimensions=ym:s:searchEngineName&metrics=ym:s:visits,ym:s:users&filters=ym:s:trafficSourceName=='Search engine traffic' AND ym:pv:URL=@'help'&id=44147844
```

### Response
#### Success Response (200)
- **data** (array) - Array of report rows.
- **total_rows** (integer) - Total number of rows.
- **sampled** (boolean) - Whether the data is sampled.
- **sample_share** (number) - Share of sampled data.
- **sample_size** (integer) - Size of the sample.
- **totals** (array) - Totals for the requested metrics.
- **query** (object) - The query parameters used.

#### Response Example
```json
{
  "data": [
    {
      "dimensions": [
        {
          "id": "searchEngineName",
          "name": "Yandex"
        }
      ],
      "metrics": [
        12345,
        6789
      ]
    }
  ],
  "total_rows": 1,
  "sampled": false,
  "sample_share": 1,
  "sample_size": 12345,
  "totals": [
    12345,
    6789
  ],
  "query": {
    "dimensions": "ym:s:searchEngineName",
    "metrics": "ym:s:visits,ym:s:users",
    "filters": "ym:s:trafficSourceName=='Search engine traffic' AND ym:pv:URL=@'help'",
    "id": 44147844
  }
}
```
```

--------------------------------

### GET /stat/v1/data/bytime

Source: https://yandex.ru/dev/metrika/en/stat

Generates a report with data divided over units of time (such as days, weeks, and months). This format is convenient for building charts and tracking trends.

```APIDOC
## GET /stat/v1/data/bytime

### Description
Generates a report with data divided over units of time (such as days, weeks, and months). This format is convenient for building charts and tracking trends.

### Method
GET

### Endpoint
/stat/v1/data/bytime

### Parameters
#### Query Parameters
- **dimensions** (string) - Required - Comma-separated list of dimensions to group data by. Must use the `ym:s:` or `ym:pv:` prefix.
- **metrics** (string) - Required - Comma-separated list of metrics to calculate. Must use the `ym:s:` or `ym:pv:` prefix.
- **filters** (string) - Optional - Filter expression to segment data. Can use a different prefix than the request and multiple sets.
- **id** (integer) - Required - The ID of the counter (or goal) to request data for.

### Request Example
```
https://api-metrika.yandex.net/stat/v1/data/bytime?dimensions=ym:s:searchEngineName&metrics=ym:s:visits,ym:s:users&filters=ym:s:trafficSourceName=='Search engine traffic' AND ym:pv:URL=@'help'&id=44147844
```

### Response
#### Success Response (200)
- **data** (array) - Array of report rows.
- **total_rows** (integer) - Total number of rows.
- **sampled** (boolean) - Whether the data is sampled.
- **sample_share** (number) - Share of sampled data.
- **sample_size** (integer) - Size of the sample.
- **totals** (array) - Totals for the requested metrics.
- **query** (object) - The query parameters used.

#### Response Example
```json
{
  "data": [
    {
      "dimensions": [
        {
          "id": "searchEngineName",
          "name": "Yandex"
        }
      ],
      "metrics": [
        12345,
        6789
      ]
    }
  ],
  "total_rows": 1,
  "sampled": false,
  "sample_share": 1,
  "sample_size": 12345,
  "totals": [
    12345,
    6789
  ],
  "query": {
    "dimensions": "ym:s:searchEngineName",
    "metrics": "ym:s:visits,ym:s:users",
    "filters": "ym:s:trafficSourceName=='Search engine traffic' AND ym:pv:URL=@'help'",
    "id": 44147844
  }
}
```
```

--------------------------------

### GET /stat/v1/data/drilldown

Source: https://yandex.ru/dev/metrika/en/stat

Generates a single branch of a tree view report. Use this method to create branches.

```APIDOC
## GET /stat/v1/data/drilldown

### Description
Generates a single branch of a tree view report. Use this method to create branches.

### Method
GET

### Endpoint
/stat/v1/data/drilldown

### Parameters
#### Query Parameters
- **dimensions** (string) - Required - Comma-separated list of dimensions to group data by. Must use the `ym:s:` or `ym:pv:` prefix.
- **metrics** (string) - Required - Comma-separated list of metrics to calculate. Must use the `ym:s:` or `ym:pv:` prefix.
- **filters** (string) - Optional - Filter expression to segment data. Can use a different prefix than the request and multiple sets.
- **id** (integer) - Required - The ID of the counter (or goal) to request data for.

### Request Example
```
https://api-metrika.yandex.net/stat/v1/data/drilldown?dimensions=ym:s:searchEngineName&metrics=ym:s:visits,ym:s:users&filters=ym:s:trafficSourceName=='Search engine traffic' AND ym:pv:URL=@'help'&id=44147844
```

### Response
#### Success Response (200)
- **data** (array) - Array of report rows.
- **total_rows** (integer) - Total number of rows.
- **sampled** (boolean) - Whether the data is sampled.
- **sample_share** (number) - Share of sampled data.
- **sample_size** (integer) - Size of the sample.
- **totals** (array) - Totals for the requested metrics.
- **query** (object) - The query parameters used.

#### Response Example
```json
{
  "data": [
    {
      "dimensions": [
        {
          "id": "searchEngineName",
          "name": "Yandex"
        }
      ],
      "metrics": [
        12345,
        6789
      ]
    }
  ],
  "total_rows": 1,
  "sampled": false,
  "sample_share": 1,
  "sample_size": 12345,
  "totals": [
    12345,
    6789
  ],
  "query": {
    "dimensions": "ym:s:searchEngineName",
    "metrics": "ym:s:visits,ym:s:users",
    "filters": "ym:s:trafficSourceName=='Search engine traffic' AND ym:pv:URL=@'help'",
    "id": 44147844
  }
}
```
```

--------------------------------

### GET /stat/v1/data

Source: https://yandex.ru/dev/metrika/en/stat

Retrieves report data in JSON format. This is the default format and can be omitted from the URL.

```APIDOC
## [GET] /stat/v1/data

### Description
Retrieves report data in JSON format. This is the default format and can be omitted from the URL.

### Method
GET

### Endpoint
https://api-metrika.yandex.net/stat/v1/data

### Parameters
#### Query Parameters
- **counter_id** (string) - Required - Counter ID
- **metrics** (string) - Required - Metrics to request
- **dimensions** (string) - Optional - Dimensions to group by

### Response
#### Success Response (200)
- **contains_sensitive_data** (boolean) - Indicates whether the response contains data with limited disclosure.

#### Response Example
JSON format response body.
```

--------------------------------

### GET /stat/v1/data.csv

Source: https://yandex.ru/dev/metrika/en/stat

Retrieves report data in CSV format. The format is specified by appending .csv to the endpoint path.

```APIDOC
## [GET] /stat/v1/data.csv

### Description
Retrieves report data in CSV format. The format is specified by appending .csv to the endpoint path.

### Method
GET

### Endpoint
https://api-metrika.yandex.net/stat/v1/data.csv

### Parameters
#### Query Parameters
- **counter_id** (string) - Required - Counter ID
- **metrics** (string) - Required - Metrics to request
- **dimensions** (string) - Optional - Dimensions to group by

### Response
#### Success Response (200)
- **contains_sensitive_data** (boolean) - Indicates whether the response contains data with limited disclosure.

#### Response Example
CSV format response body.
```

--------------------------------

### GET request with CSV format

Source: https://yandex.ru/dev/metrika/en/stat/index

Specifies the CSV response format by adding .csv to the API endpoint. The request includes counter_id, metrics, and dimensions parameters.

```http
GET https://api-metrika.yandex.net/stat/v1/data.**csv**?<counter_id>&<metrics>&<dimensions>
```

--------------------------------

### GET request with default JSON format

Source: https://yandex.ru/dev/metrika/en/stat/index

Uses the default JSON format by omitting the format extension from the API endpoint. The request includes counter_id, metrics, and dimensions parameters.

```http
GET https://api-metrika.yandex.net/stat/v1/data?<counter_id>&<metrics>&<dimensions>
```

--------------------------------

### SQL-like query for report data

Source: https://yandex.ru/dev/metrika/en/stat

Shows how the report can be imagined as a SQL query to a hypothetical table of sessions, grouping by operating system and calculating average page depth.

```sql
SELECT operatingSystem, avg(depth) from visits GROUP BY operatingSystem
```

--------------------------------

### Request CSV format

Source: https://yandex.ru/dev/metrika/en/stat

Specify the CSV format by adding .csv after 'data' in the URL. The format is appended to the endpoint path.

```http
GET https://api-metrika.yandex.net/stat/v1/data.**csv**?<counter_id>&<metrics>&<dimensions>

```

--------------------------------

### Request default JSON format

Source: https://yandex.ru/dev/metrika/en/stat

JSON is the default format and can be omitted from the URL. This request returns JSON.

```http
GET https://api-metrika.yandex.net/stat/v1/data?<counter_id>&<metrics>&<dimensions>

```
Tokens:
Raw