更新时间:2023.04.11 16:29:06
调用UrlOverviewMetrics接口获取页面相关指标。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 |
| 请求名称。 |
Version | String | 是 |
| 请求版本。 |
ServiceName : apmplus_openapi Region : cn-beijing X-App-Ids : xxx Content-Type : application/json
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
common | object of common | 是 | - | 通用参数。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
aid | i64 | 是 |
| 应用ID。 |
site_type | string | 是 |
| 站点类型。 |
env | string | 是 |
| 环境,填""时为全部。 |
os | string | 否 |
| 服务类型,可选值为webpro,app,minipro。 |
user | string | 否 |
| 用户名。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
data | array of data | - | 页面指标。 |
error_msg | string | - | 错误信息,成功为空。 |
error_no | i32 |
| 错误码,成功为0。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
description | string |
| 指标名。 |
groupKey | string |
| 组别key。 |
groupName | string |
| 组名。 |
name | string |
| 指标key。 |
isDefault | boolean |
| 是否默认展示。 |
type | string |
| 指标值类型。
|
unit | string |
| 指标值单位。 |
POST https://open.volcengineapi.com/?Action=UrlOverviewMetrics&Version=2022-10-12 { "common": { "aid": 12345, "site_type": "web", "env": "online", "os": "webpro", "user": "test_user" } }
{ "error_msg": "", "data": [ { "type": "number", "groupKey": "js_error", "isDefault": true, "groupName": "JS错误", "unit": "ms", "name": "js_error.count", "description": "PV" } ], "error_no": 0 }
{ "ResponseMetadata": { "RequestId": "201806041104200100100232280022D30", "Action": "UrlOverviewMetrics", "Version": "2022-10-12", "Service": "***", "Region": "cn-north-1", "Error": { "Code": "200000", "Message": "参数异常" } } }