获取具体类型的上报详情列表。
请求说明
- 请求方式：POST
- 请求地址：https://open.volcengineapi.com/?Action=DataList&Version=2022-10-12
ServiceName: apmplus_openapi
Region: cn-beijing
X-App-Ids: xxx
Content-Type: application/json
请求参数
Query
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|
| Action | String | 是 | DataList | 接口名称。当前 API 的名称为 DataList。 |
| Version | String | 是 | 2022-10-12 | 接口版本。当前 API 的版本为 2022-10-12。 |
Body
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|
| common | Object of CommonParams | 是 | - | 通用参数。 |
| time_filter | Object of TimeFilter | 是 | - | 时间区间。 |
| filter_conditions | Object of FilterCondition | 是 | - | 筛选条件。 |
| page_num | Integer | 是 | 1 | 页号。 |
| page_size | Integer | 是 | 10 | 每页项数。 |
| ev_type | String | 是 | session | 上报类型。 |
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不能同时存在。 |
返回参数
| 参数 | 类型 | 示例值 | 描述 |
|---|
| data | Object of DataListData | - | 指定类型的上报详情list。 |
| error_msg | String | - | 错误信息，成功为空。 |
| error_no | Integer | 0 | 错误码，成功为0。 |
DataListData
| 参数 | 类型 | 示例值 | 描述 |
|---|
| count | Integer | 10 | 总上报量。 |
| table_list | Array of DataListItem | - | 具体页号的上报详情list，按客户端时间倒序返回。 |
DataListItem
| 参数 | 类型 | 示例值 | 描述 |
|---|
| json | String | - | 原始上报json。 |
| ev_type | String | session | 上报类型。 |
| metric_map | JSON Map | - | 具体上报详情。 |
MetricMap
| 参数 | 类型 | 示例值 | 描述 |
|---|
| key | String | browser_brand | 上报参数的key。 |
| value | Object of MetricData | - | 上报参数的key的取值。 |
MetricData
| 参数 | 类型 | 示例值 | 描述 |
|---|
| unit | String | ms | 维度值的单位。 |
| label | String | browser_brand | 维度名。 |
| value | String | Chrome | 某个维度的上报值。 |
| groupKey | String | - | 维度的组的key。 |
| groupName | String | - | 维度的组名称。 |
请求示例
POST https://open.volcengineapi.com/?Action=DataList&Version=2022-10-12
{
"common": {
"aid": 12345,
"site_type": "web",
"env": "online",
"os": "webpro",
"user": "test_user"
},
"time_filter": {
"start_time": 1665485413,
"end_time": 1665744613,
"granularity": 3600
},
"filter_conditions": {
"type": "and",
"values": "[数据探索]",
"field": "pid",
"op": "in",
"children": [
{
"type": "and",
"field": "pid",
"children": [],
"op": "in",
"groupKey": "context",
"values": "[数据探索]"
}
],
"groupKey": "context"
},
"page_num": 1,
"page_size": 10,
"ev_type": "session"
}
返回示例
{
"data": {
"table_list": [
{
"ev_type": "session",
"json": "bored",
"metric_map": "{\"browser_brand\":{\"value\":\"Chrome\",\"label\":\"browser_brand\",\"groupKey\":\"\",\"groupName\":\"\"},\"fcp\":{\"value\":\"1109.6\",\"label\":\"首次有内容渲染时间(FCP)\",\"unit\":\"ms\",\"groupKey\":\"\",\"groupName\":\"\"}"
}
]
},
"error_no": 0,
"error_msg": ""
}
错误码
本接口无特有的错误码。更多信息请参见错误码。