AnalyseDimensionList--应用性能监控全链路版-火山引擎

文档中心

立即注册

导航

AnalyseDimensionList

最近更新时间：2025.01.23 17:50:40首次发布时间：2025.01.23 17:50:40

查看事件维度详情页列表。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com?Action=AnalyseDimensionList&Version=2022-10-12

请求参数

ServiceName: apmplus_openapi
Region: cn-beijing
X-App-Ids: xxx
Content-Type: application/json

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`AnalyseDimensionList`	接口名称。当前 API 的名称为 `AnalyseDimensionList`。
Version	String	是	`2022-10-12`	接口版本。当前 API 的版本为 `2022-10-12`。

Body

参数	类型	是否必选	示例值	描述
os	String	是	`Android`	操作系统（Android, iOS）
start_time	Integer	是	`1630473600`	开始时间
end_time	Integer	是	`1630560000`	结束时间
filters	Object of Condition	是	`-`	筛选条件，可以指定多个键值对来筛选数据。
order_by	String	是	`count`	排序方式（count, user, per_capita）
keyword	String	否	`example_keyword`	关键词
event_name	String	否	`event`	事件名称（可选）
attribute_name	String	否	`name`	属性名称（可选）
attribute_type	String	否	`string`	属性类型（可选）
page_no	Integer	是	`1`	页码
page_size	Integer	是	`20`	每页大小

Condition

参数	类型	是否必选	示例值	描述
op	String	否	`in`	操作符。 gt：大于 gte：大于等于 lt：小于 lte：小于等于 eq：等于 neq：不等于 in：包含 not_in：不包含 lk：模糊匹配特定模式的数据 nlk：排除模糊匹配的数据
type	String	否	`expression`	筛选条件类型。 expression：当前condition是一个表达式。 and：当前condition是一个复合表达式，多个sub_condition的逻辑关系是and。 or：当前condition是一个复合表达式，多个sub_condition的逻辑关系是or。 map：当前condition是map类型。
value	String	否	`Android`	筛选值。
values	Array of String	否	`["Android"]`	筛选值，支持多个。
map_key	String	否	`key_1`	map类型key，当type为map时必填。
dimension	String	否	`aid`	条件的名称。
sub_conditions	Array of Condition	否	`-`	子条件。

返回参数

参数	类型	示例值	描述
data	Object of DimensionListData		事件维度数据列表
error_msg	String	`success`	错误消息
error_no	Long	`500`	错误码

DimensionListData

参数	类型	示例值	描述
data	Array of DimensionListItem		维度列表
total	Integer	`10`	维度总数

DimensionListItem

参数	类型	示例值	描述
name	String	`10`	维度名
count	Long	`100`	上报量
attribute_id	Long	`10`	属性ID

请求示例

POST https://open.volcengineapi.com?Action=AnalyseDimensionList&Version=2022-10-12
{
    "os": "Android",
    "start_time": 1630473600,
    "end_time": 1630560000,
    "filters": {},
    "order_by": "count",
    "page_no": 1,
    "page_size": 20
}

返回示例

{
    "data": {
        "data": [
            {
                "name": "10",
                "count": 100,
                "attribute_id": 10
            }
        ],
        "total": 10
    },
    "error_msg": "success",
    "error_no": 500
}

错误码

本接口无特有的错误码。更多信息请参见错误码。

应用性能监控全链路版

请求说明

请求参数

Header

Query

Body

Condition

返回参数

DimensionListData

DimensionListItem

请求示例

返回示例

错误码