Table
Provides access to statistical data, including data available in reports. Returns results in the form of a table.
Request format
https://api.appmetrica.yandex.ru/stat/v1/data
? ids=<int,int,...>
& metrics=<string>
& [accuracy=<string>]
& [callback=<string>]
& [date1=<string>]
& [date2=<string>]
& [dimensions=<string>]
& [filters=<string>]
& [group=<group_type>]
& [id=<integer>]
& [include_undefined=<boolean>]
& [lang=<string>]
& [limit=<integer>]
& [offset=<integer>]
& [pretty=<boolean>]
& [sort=<string>]
ids * | Comma-separated list of counter numbers. Used instead of the id parameter. |
metrics * | Comma-separated list of metrics. Limit: 20 metrics per request. |
accuracy | Accuracy of results. Allows you to manage sampling (the number of visits used to calculate the final value). Default value: medium |
callback | Callback function that processes the API response. |
date1 | Start date of the report period in the format YYYY-MM-DD. You can also use the values: Default value: |
date2 | End date of the report period in the format YYYY-MM-DD. You can also use the values: Default value: |
dimensions | Comma-separated list of dimensions. Limit: 10 dimensions per request. |
filters | Limit: Maximum of 10 unique dimensions and metrics, 20 separate filters, and 10,000 characters per filter string. |
group | Grouping data by time. Default value: week Acceptable values:
|
id | The tag number. Obsolete. Use ids . |
include_undefined | Outputs rows that don't have defined dimension values. This only affects the first dimension. Disabled by default. |
lang | Language. |
limit | Number of items on the results page. Limit: 100000. Default value: 100 |
offset | Index of the first row of requested data, starting from 1. Default value: 1 |
pretty | Specifies the formatting for results. To use formatting, set the value to true .Default value: |
sort | Comma-separated list of dimensions and metrics to use for sorting. By default, sorting occurs in ascending order. To sort data in descending order, put the “-” sign before the dimension or metric. |
ids * | Comma-separated list of counter numbers. Used instead of the id parameter. |
metrics * | Comma-separated list of metrics. Limit: 20 metrics per request. |
accuracy | Accuracy of results. Allows you to manage sampling (the number of visits used to calculate the final value). Default value: medium |
callback | Callback function that processes the API response. |
date1 | Start date of the report period in the format YYYY-MM-DD. You can also use the values: Default value: |
date2 | End date of the report period in the format YYYY-MM-DD. You can also use the values: Default value: |
dimensions | Comma-separated list of dimensions. Limit: 10 dimensions per request. |
filters | Limit: Maximum of 10 unique dimensions and metrics, 20 separate filters, and 10,000 characters per filter string. |
group | Grouping data by time. Default value: week Acceptable values:
|
id | The tag number. Obsolete. Use ids . |
include_undefined | Outputs rows that don't have defined dimension values. This only affects the first dimension. Disabled by default. |
lang | Language. |
limit | Number of items on the results page. Limit: 100000. Default value: 100 |
offset | Index of the first row of requested data, starting from 1. Default value: 1 |
pretty | Specifies the formatting for results. To use formatting, set the value to true .Default value: |
sort | Comma-separated list of dimensions and metrics to use for sorting. By default, sorting occurs in ascending order. To sort data in descending order, put the “-” sign before the dimension or metric. |
* Required
Response format
{
"total_rows" : <long>,
"sampled" : <boolean>,
"sample_share" : <double>,
"sample_size" : <long>,
"sample_space" : <long>,
"data_lag" : <int>,
"query" : {
"ids" : [ <int>, ... ],
"dimensions" : [ <string>, ... ],
"metrics" : [ <string>, ... ],
"sort" : [ <string>, ... ],
"date1" : <string>,
"date2" : <string>,
"filters" : <string>,
"limit" : <integer>,
"offset" : <integer>
},
"totals" : [ <double>, ... ],
"min" : [ <double>, ... ],
"max" : [ <double>, ... ],
"data" : [ {
"dimensions" : [ {
"key_1" : <string>,
"key_2" : ...
}, ... ],
"metrics" : [ <double>, ... ]
}, ... ]
}
Parameters | Description |
---|---|
total_rows | The total number of rows in the response. |
sampled | Sampling flag. Indicates whether sampling was applied. Possible values: true , false . |
sample_share | Percentage of data used for the calculation. Available values range from 0 to 1. |
sample_size | Number of rows in the requested data. |
sample_space | Number of data rows. |
data_lag | Delay in updating data, in seconds. |
query | Original request. Contains the request parameters, including detailed parameters from the template and parameters for attribute parametrization. |
totals | Total results for metrics across the entire dataset (with filtration). |
min | Minimum results for metrics among keys output. |
max | Maximum results for metrics among keys output. |
data | Response rows. An array in which each item is a single row of the result. |
ids | Counter IDs. |
dimensions | Array of dimensions. |
metrics | Array of metrics. |
sort | Array of sortings. |
date1 | Start date of the report period in the format YYYY-MM-DD. |
date2 | End date of the report period in the format YYYY-MM-DD. |
filters | Segmentation filter. |
limit | Number of items on the results page. |
offset | Index of the first row of requested data, starting from 1. |
dimensions | Array of dimension values for this row. Each dimension value is an object. It must have the name field, which is a text value. But it can also have additional fields, such as id . |
metrics | Array of metric values for this row. The values in this array are numbers or null . |
Parameters | Description |
---|---|
total_rows | The total number of rows in the response. |
sampled | Sampling flag. Indicates whether sampling was applied. Possible values: true , false . |
sample_share | Percentage of data used for the calculation. Available values range from 0 to 1. |
sample_size | Number of rows in the requested data. |
sample_space | Number of data rows. |
data_lag | Delay in updating data, in seconds. |
query | Original request. Contains the request parameters, including detailed parameters from the template and parameters for attribute parametrization. |
totals | Total results for metrics across the entire dataset (with filtration). |
min | Minimum results for metrics among keys output. |
max | Maximum results for metrics among keys output. |
data | Response rows. An array in which each item is a single row of the result. |
ids | Counter IDs. |
dimensions | Array of dimensions. |
metrics | Array of metrics. |
sort | Array of sortings. |
date1 | Start date of the report period in the format YYYY-MM-DD. |
date2 | End date of the report period in the format YYYY-MM-DD. |
filters | Segmentation filter. |
limit | Number of items on the results page. |
offset | Index of the first row of requested data, starting from 1. |
dimensions | Array of dimension values for this row. Each dimension value is an object. It must have the name field, which is a text value. But it can also have additional fields, such as id . |
metrics | Array of metric values for this row. The values in this array are numbers or null . |
Sample request
curl -X GET \ 'https://api.appmetrica.yandex.ru/stat/v1/data?ids=1111&metrics=ym:ge:users' \ -H 'Authorization: OAuth 05dd3dd84ff948fdae2bc4fb91f13e22bb1f289ceef0037'
Copied to clipboard
GET /stat/v1/data?ids=1111&metrics=ym:ge:users HTTP/1.1 Host: api.appmetrica.yandex.ru Authorization: OAuth 05dd3dd84ff948fdae2bc4fb91f13e22bb1f289ceef0037
Copied to clipboard