获取具体自定义事件的category和metric聚合列表。
请求说明
- 请求方式：POST
- 请求地址：https://open.volcengineapi.com/?Action=EventTypeDetail&Version=2022-10-12
ServiceName: apmplus_openapi
Region: cn-beijing
X-App-Ids: xxx
Content-Type: application/json
请求参数
Query
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|
| Action | String | 是 | EventTypeDetail | 接口名称。当前 API 的名称为 EventTypeDetail。 |
| Version | String | 是 | 2022-10-12 | 接口版本。当前 API 的版本为 2022-10-12。 |
Body
CommonParams
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|
| aid | Long | 是 | 12345 | 应用ID。 |
| site_type | String | 是 | web | 站点类型。 |
| env | String | 是 | online | 环境，填""时为全部。 |
| os | String | 否 | webpro | 服务类型，可选值为webpro，app，minipro。 |
| user | String | 否 | test_user | 用户名。 |
TimeFilter
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|
| start_time | Integer | 是 | 1665485413 | 起始时间，单位s。 |
| end_time | Integer | 是 | 1665744613 | 终止时间，单位s。 |
| granularity | Integer | 否 | 3600 | 聚合时间粒度，单位s。 |
FilterCondition
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|
| type | String | 是 | and | 筛选条件类型，可选值为and和rule，只支持两层，第一层的type必须为and，第二层的type必须为rule。 |
| field | String | 否 | pid | 条件字段key，可选值集合由GetFieldKeys方法获取。 |
| op | String | 否 | in | 条件符号，可选值有eq，neq，lt，lte，gt，gte，in，not_in，regex，not_regex。 |
| groupKey | String | 否 | context | map类型字段key，可选值集合由GetFieldKeys方法获取。 |
| values | Array of String | 否 | [数据探索] | 条件值，可选值集合由GetFieldValues方法获取。 |
| children | Array of FilterCondition | 否 | - | 如果下层还有条件，则放入该处，即type为and时必填。这一层与field，op，groupkey以及values不能同时存在。 |
返回参数
EventTypeDetailResponseData
EventTypeDetailMetric
| 参数 | 类型 | 示例值 | 描述 |
|---|
| avg | Double | 1.2 | 该metric key对应的metric value的avg聚合值。 |
| count | Integer | 10 | 该metric key上报次数。 |
| pct25 | Double | 1.0 | 该metric key对应的metric value的pct25聚合值。 |
| pct50 | Double | 1.2 | 该metric key对应的metric value的pct50聚合值。 |
| pct70 | Double | 1.3 | 该metric key对应的metric value的pct70聚合值。 |
| pct90 | Double | 1.4 | 该metric key对应的metric value的pct90聚合值。 |
| pct99 | Double | 1.5 | 该metric key对应的metric value的pct99聚合值。 |
| metric_name | String | metric_key_test | metric key。 |
EventTypeDetailCategory
| 参数 | 类型 | 示例值 | 描述 |
|---|
| count | Integer | 10 | 该category key上报次数。 |
| top_values | Array of EventTypeDetailCategoryValue | - | 该category key对应的value top20上报情况。 |
| category_name | String | category_key_test | category key。 |
EventTypeDetailCategoryValue
| 参数 | 类型 | 示例值 | 描述 |
|---|
| pct | Double | 0.12 | 该category key对应的value上报量占所有value上报量的占比。 |
| count | Integer | 10 | 该category key对应的value上报量。 |
| value | String | category_value_test | 该category key对应的value。 |
请求示例
POST https://open.volcengineapi.com/?Action=EventTypeDetail&Version=2022-10-12
{
"common": {
"aid": 12345,
"site_type": "web",
"env": "online",
"user": "test_user",
"os": "webpro"
},
"time_filter": {
"start_time": 1665485413,
"end_time": 1665744613,
"granularity": 3600
},
"event_name": "event_test",
"filter_conditions": {
"type": "and",
"op": "in",
"values": "[数据探索]",
"children": [
{
"type": "and",
"field": "pid",
"op": "in",
"values": "[数据探索]",
"groupKey": "context",
"children": []
}
],
"groupKey": "context",
"field": "pid"
}
}
返回示例
{
"error_no": 0,
"data": {
"metric_list": [
{
"metric_name": "metric_key_test",
"pct70": 1.3,
"pct25": 1,
"pct99": 1.5,
"count": 10,
"pct90": 1.4,
"pct50": 1.2,
"avg": 1.2
}
],
"category_list": [
{
"top_values": [
{
"pct": 0.12,
"value": "category_value_test",
"count": 10
}
],
"count": 10,
"category_name": "category_key_test"
}
]
},
"error_msg": ""
}
错误码
本接口无特有的错误码。更多信息请参见错误码。