获取指定session下的trace详情。
请求说明
- 请求方式：POST
- 请求地址：https://open.volcengineapi.com/?Action=SessionList&Version=2022-10-12
ServiceName: apmplus_openapi
Region: cn-beijing
X-App-Ids: xxx
Content-Type: application/json
请求参数
Query
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|
| Action | String | 是 | SessionList | 接口名称。当前 API 的名称为 SessionList。 |
| Version | String | 是 | 2022-10-12 | 接口版本。当前 API 的版本为 2022-10-12。 |
Body
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|
| common | Object of CommonParams | 是 | - | 通用参数。 |
| slardar_session_id | String | 是 | 452551f8-xxx-9d50078ennb6 | session_id，可从DataList接口获取。 |
| timestamp | Integer | 是 | 1668576681 | session开始的时间戳，可从DataList接口获取。 |
| next_key | String | 否 | - | 每次请求最多只返回200条，超过200条会返回next_key，下一次请求附上next_key，从next_key处再返回200条。 |
CommonParams
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|
| aid | Long | 是 | 12345 | 应用ID。 |
| site_type | String | 是 | web | 站点类型。 |
| env | String | 是 | online | 环境，填""时为全部。 |
| os | String | 否 | webpro | 服务类型，可选值为webpro，app，minipro。 |
| user | String | 否 | test_user | 用户名。 |
返回参数
| 参数 | 类型 | 示例值 | 描述 |
|---|
| data | Object of SessionListResponseData | - | 指定session的trace详情。 |
| error_msg | String | "" | 错误信息，成功为空。 |
| error_no | Integer | 0 | 错误码，成功为0。 |
SessionListResponseData
| 参数 | 类型 | 示例值 | 描述 |
|---|
| next_key | String | - | 每次请求最多只返回200条，超过200条会返回next_key。 |
| table_list | Array of DataListItem | - | trace详情。 |
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=SessionList&Version=2022-10-12
{
"common": {
"aid": 12345,
"site_type": "web",
"env": "online",
"user": "test_user",
"os": "webpro"
},
"slardar_session_id": "452551f8-xxx-9d50078ennb6",
"timestamp": 1668576681,
"next_key": ""
}
返回示例
{
"error_no": 0,
"data": {
"table_list": [
{
"metric_map": "{\"browser_brand\":{\"value\":\"Chrome\",\"label\":\"browser_brand\",\"groupKey\":\"\",\"groupName\":\"\"},\"fcp\":{\"value\":\"1109.6\",\"label\":\"首次有内容渲染时间(FCP)\",\"unit\":\"ms\",\"groupKey\":\"\",\"groupName\":\"\"}",
"ev_type": "session",
"json": ""
}
],
"next_key": ""
},
"error_msg": ""
}
错误码
本接口无特有的错误码。更多信息请参见错误码。