Retrieves the report dimension hierarchy.

Method	`getobj.dimensions_tree`
Description	Retrieves the report dimension hierarchy.
Who has access	Agents and clients
Required components	Data API for configuration
Request weight	1 point

Request parameters

Name	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 agent) To 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	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

Example request

{
"jsonrpc":"2.0",
"id":"number",
"method":"getobj.dimensions_tree",
"params":{
"access_token":"string",
"user_id":"number",
"report_type": "enum"
}
}

Example response

{
"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"
}
]
}
}
}

Example response

{
"jsonrpc": "2.0",
"id": "number",
"result": {
"metadata": {
},
"data": {
"dimensions_groups": [
{
"id": 1,
"name": "Advertising platform",
"description": "Parameters imported from external platforms",
"parent_group_id": null,
"sort": 100
},
{
"id": 2,
"name": "My dimensions",
"description": "User-defined parameters",
"parent_group_id": 1,
"sort": 200
}
],
"dimensions": [
{
"id": "campaign_ext_name",
"name": "Integrated advertising campaign",
"description": "External advertising campaign name",
"group_id": 2,
"sort": 201,
"data_type": "string",
"is_custom": false,
"is_entity_separated": false
},
{
"id": "banner_group_name",
"name": "Ad group",
"description": "Ad group name in the advertising platform",
"group_id": null,
"sort": 401,
"data_type": "string",
"is_custom": false,
"is_entity_separated": false
}
]
}
}

}

Possible errors

See the "Errors for getobj methods" section.