| Method | getobj.dimensions_tree |
|---|---|
| Description | Getting dimension nesting |
| Available to | Agent, Client |
| Necessary components for working with the method | Data API for configuration |
| Method weight | 1 point |
Request parameters
| Title | Type | Required | Description |
|---|---|---|---|
access_token |
string | yes | Authentication session key |
user_id |
number | no | Unique user identifier of the agent client on behalf of which the request is made Is required for the agentTo obtain a list of client users, you must use the method "get.customer_users" |
report_type |
enum | yes | User report type. Currently only works for report type call_summary_uis. To get a list of user reports, you must use the method "get.reports_list" |
Response parameters
| Name | Type | Valid values | Default response | Description | ||
|---|---|---|---|---|---|---|
| Dimension groups | ||||||
dimensions_groups |
array | yes | List of measurement groups | |||
id |
number | Dimension group ID | ||||
name |
string | > | Measurement group name | |||
description |
string | Description of the measurement group. Displayed in tooltip | ||||
parent_group_id |
number | Identifier of the measurement group in the attachment of which this measurement group is located | ||||
sort |
number | End-to-end identifier used for sorting in the dimension tree. | ||||
| Measurements | ||||||
dimensions |
array | yes | List of dimensions | |||
id |
enum | Measurement mnemonics | ||||
name |
string | Dimension name | ||||
description |
string | Measurement description. Displayed in tooltip | ||||
group_id |
number | Identifier of the measurement group in which this measurement is located | ||||
sort |
number | End-to-end identifier used for sorting in the dimension tree. | ||||
data_type |
enum | yes | Data format | |||
is_custom |
boolean | yes | Is the dimension custom | |||
is_entity_separated |
boolean | yes | Is the custom dimension extended | |||
JSON request structure```json
{ "jsonrpc":"2.0", "id":"number", "method":"getobj.dimensions_tree", "params":{ "access_token":"string", "user_id":"number", "report_type": "enum" } }
### JSON response structure```JSON
{
"jsonrpc": "2.0",
"id": "number",
"result": {
"metadata": {
},
"data": {
"dimensions_groups": [
{
"id": "number",
"name": "string",
"description": "string",
"parent_group_id": "number",
"sort": "number"
}
],
"dimensions": [
{
"id": "enum",
"name": "string",
"description": "string",
"group_id": "number",
"sort": "number",
"data_type": "enum",
"is_custom": "boolean",
"is_entity_separated": "boolean"
}
]
}
}
}
JSON Example response```JSON
{ "jsonrpc": "2.0", "id": "number", "result": { "metadata": {
},
"data": {
"dimensions_groups": [
{
"id": 1,
"name": "Рекламная система",
"description": "Параметры подтянутые из внешних систем",
"parent_group_id": null,
"sort": 100
},
{
"id": 2,
"name": "Мои измерения",
"description": "Параметры созданные пользователем",
"parent_group_id": 1,
"sort": 200
}
],
"dimensions": [
{
"id": "campaign_ext_name",
"name": "Интегрированная рекламная кампания",
"description": "Название внешней рекламной кампании",
"group_id": 2,
"sort": 201,
"data_type": "string",
"is_custom": false,
"is_entity_separated": false
},
{
"id": "banner_group_name",
"name": "Группа объявлений",
"description": "Название группы объявлений в рекламной системе",
"group_id": null,
"sort": 401,
"data_type": "string",
"is_custom": false,
"is_entity_separated": false
}
]
}
}
} ```
List of returned errors
Look at the section "List of errors for methods with the verb getobj"