Drill down
Used to generate a multi-level (tree view) report. Each level corresponds to a single dimension.
A request to the drilldown
method returns one sublevel for the specified parent level. The parent level is specified in the parent_id
parameter. To get data for the top level, send a request without the parent_id
parameter.
To get data for nested levels, you must specify the path from the root. The path is formed from values of the id
field for the dimension
parameter. If the id field is omitted, specify the name
field.
See an example with this request.
Request syntax
https://api-metrika.yandex.net/stat/v1/data/drilldown
? ids=<int,int,...>
& metrics=<string>
& [accuracy=<string>]
& [callback=<string>]
& [date1=<string>]
& [date2=<string>]
& [dimensions=<string>]
& [direct_client_logins=<string,_string,...>]
& [filters=<string>]
& [id=<integer>]
& [include_undefined=<boolean>]
& [lang=<string>]
& [limit=<int>]
& [offset=<int>]
& [only_expandable_undefined=<boolean>]
& [parent_id=<list>]
& [preset=<string>]
& [pretty=<boolean>]
& [proposed_accuracy=<boolean>]
& [sort=<string>]
& [timezone=<string>]
ids * | Comma-separated list of counter IDs. Used instead of the id parameter. |
metrics * | Comma-separated list of metrics. Limit: 20 metrics per request. |
accuracy | Sample size for the report. Use it to control the sampling rate (the number of sessions used for calculating results). Default value: medium |
callback | Callback function that processes the API response. |
date1 | Start date of the sample period in YYYY-MM-DD format. You can also use the values: Default value: |
date2 | End date of the sample period in YYYY-MM-DD format. You can also use the values: Default value: |
dimensions | Comma-separated list of dimensions. Limit: 10 dimensions per request. |
direct_client_logins | Comma-separated usernames of Yandex Direct clients. They can be used for generating the Yandex Direct — costs report. |
filters | Limits: up to 10 unique dimensions and metrics; up to 20 separate filters; up to 10,000 characters per filter row; and up to 100 values per filtering condition. |
id | Tag ID. 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: 100,000. Default value: 100 |
offset | Index of the first row of requested data, starting from 1. Default value: 1 |
only_expandable_undefined | Deletes unexpanded, undefined values from results. Use only when include_undefined=true. |
parent_id | Row for expanding further. Consists of a JSON list of keys. Default value: [] |
preset | Report presets. |
pretty | Specifies the formatting for results. To use formatting, set the value to true .Default value: |
proposed_accuracy | If the parameter is set to true, the API has the right to automatically increase the "accuracy" parameter to the recommended value. This can help you obtain meaningful results when a request is sent to a small table with very small sampling. |
sort | Comma-separated list of dimensions and metrics to use for sorting. By default, data is sorted in descending order (indicated by the “-” symbol in front of the dimension or metric). To sort data in ascending order, remove the “-” symbol. |
timezone | Time zone in ±hh:mm format within the range of [-23:59; +23:59] (the plus sign should be denoted as |
ids * | Comma-separated list of counter IDs. Used instead of the id parameter. |
metrics * | Comma-separated list of metrics. Limit: 20 metrics per request. |
accuracy | Sample size for the report. Use it to control the sampling rate (the number of sessions used for calculating results). Default value: medium |
callback | Callback function that processes the API response. |
date1 | Start date of the sample period in YYYY-MM-DD format. You can also use the values: Default value: |
date2 | End date of the sample period in YYYY-MM-DD format. You can also use the values: Default value: |
dimensions | Comma-separated list of dimensions. Limit: 10 dimensions per request. |
direct_client_logins | Comma-separated usernames of Yandex Direct clients. They can be used for generating the Yandex Direct — costs report. |
filters | Limits: up to 10 unique dimensions and metrics; up to 20 separate filters; up to 10,000 characters per filter row; and up to 100 values per filtering condition. |
id | Tag ID. 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: 100,000. Default value: 100 |
offset | Index of the first row of requested data, starting from 1. Default value: 1 |
only_expandable_undefined | Deletes unexpanded, undefined values from results. Use only when include_undefined=true. |
parent_id | Row for expanding further. Consists of a JSON list of keys. Default value: [] |
preset | Report presets. |
pretty | Specifies the formatting for results. To use formatting, set the value to true .Default value: |
proposed_accuracy | If the parameter is set to true, the API has the right to automatically increase the "accuracy" parameter to the recommended value. This can help you obtain meaningful results when a request is sent to a small table with very small sampling. |
sort | Comma-separated list of dimensions and metrics to use for sorting. By default, data is sorted in descending order (indicated by the “-” symbol in front of the dimension or metric). To sort data in ascending order, remove the “-” symbol. |
timezone | Time zone in ±hh:mm format within the range of [-23:59; +23:59] (the plus sign should be denoted as |
* Required
Sample request
https://api-metrika.yandex.net/stat/v1/data/drilldown?ids=44147844%2C2215573&metrics=ym%3As%3Apageviews
Response format
{
"total_rows" : < long > ,
"total_rows_rounded" : < boolean > ,
"sampled" : < boolean > ,
"contains_sensitive_data" : < boolean > ,
"sample_share" : < double > ,
"sample_size" : < long > ,
"sample_space" : < long > ,
"data_lag" : < int > ,
"query" : {
"ids" : [ < int > , ... ],
"timezone" : < string > ,
"preset" : < string > ,
"dimensions" : [ < string > , ... ],
"metrics" : [ < string > , ... ],
"sort" : [ < string > , ... ],
"date1" : < string > ,
"date2" : < string > ,
"filters" : < string > ,
"limit" : < integer > ,
"offset" : < integer >
},
"totals" : [ < double > , ... ],
"min" : [ < double > , ... ],
"max" : [ < double > , ... ],
"data" : [ {
"dimension" : {
"key_1" : < string > ,
"key_2" : ...
},
"metrics" : [ < double > , ... ],
"expand" : < boolean >
}, ... ]
}
Parameters | Description |
---|---|
total_rows | The total number of rows in the response for the entire dataset (after filtering). |
total_rows_rounded | Indicates that the total number of rows was rounded. |
sampled | Sampling flag. Indicates whether sampling was applied. Possible values: true , false . |
contains_sensitive_data | Indicates whether sensitive data can be omitted from the response. This includes data calculated by Yandex algorithms: demographic data (gender, age, and other), login page addresses, search phrases, and robot information. If the value is Possible values: |
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. |
query | |
ids | Counter IDs. |
timezone | Time zone of the sample period in ±hh:mm format. |
preset | Report preset. |
dimensions | Array of dimensions. |
metrics | Array of metrics. |
sort | Array of sortings. |
date1 | Start date of the sample period in YYYY-MM-DD format. |
date2 | End date of the sample period in YYYY-MM-DD format. |
filters | Segmentation filter. |
limit | Number of items on the results page. |
offset | Index of the first row of requested data, starting from 1. |
data | |
dimension | Dimension value for the specified level of the tree. For example, the second tree level is set (the parent_id array is one ID long). In this case, the field contains the value of the second dimension in the request. |
metrics | Array of metric values for this row. The values in this array are numbers or null . |
expand | Indicates whether to expand this row to the next level of the tree. |
Parameters | Description |
---|---|
total_rows | The total number of rows in the response for the entire dataset (after filtering). |
total_rows_rounded | Indicates that the total number of rows was rounded. |
sampled | Sampling flag. Indicates whether sampling was applied. Possible values: true , false . |
contains_sensitive_data | Indicates whether sensitive data can be omitted from the response. This includes data calculated by Yandex algorithms: demographic data (gender, age, and other), login page addresses, search phrases, and robot information. If the value is Possible values: |
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. |
query | |
ids | Counter IDs. |
timezone | Time zone of the sample period in ±hh:mm format. |
preset | Report preset. |
dimensions | Array of dimensions. |
metrics | Array of metrics. |
sort | Array of sortings. |
date1 | Start date of the sample period in YYYY-MM-DD format. |
date2 | End date of the sample period in YYYY-MM-DD format. |
filters | Segmentation filter. |
limit | Number of items on the results page. |
offset | Index of the first row of requested data, starting from 1. |
data | |
dimension | Dimension value for the specified level of the tree. For example, the second tree level is set (the parent_id array is one ID long). In this case, the field contains the value of the second dimension in the request. |
metrics | Array of metric values for this row. The values in this array are numbers or null . |
expand | Indicates whether to expand this row to the next level of the tree. |