获取页面性能指标总览。
请求说明
- 请求方式：POST
- 请求地址：https://open.volcengineapi.com/?Action=PageOverview&Version=2022-10-12
ServiceName: apmplus_openapi
Region: cn-beijing
X-App-Ids: xxx
Content-Type: application/json
请求参数
Query
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|
| Action | String | 是 | PageOverview | 接口名称。当前 API 的名称为 PageOverview。 |
| Version | String | 是 | 2022-10-12 | 接口版本。当前 API 的版本为 2022-10-12。 |
Body
TimeFilter
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|
| start_time | Integer | 是 | 1665485413 | 起始时间，单位s。 |
| end_time | Integer | 是 | 1665744613 | 终止时间，单位s。 |
| granularity | Integer | 否 | 3600 | 聚合时间粒度，单位s。 |
CommonParams
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|
| aid | Long | 是 | 12345 | 应用ID。 |
| site_type | String | 是 | web | 站点类型。 |
| env | String | 是 | online | 环境，填""时为全部。 |
| os | String | 否 | webpro | 服务类型，可选值为webpro，app，minipro。 |
| user | String | 否 | test_user | 用户名。 |
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不能同时存在。 |
返回参数
PagePerfOverviewMetricItem
PerfMetricStatus
| 参数 | 类型 | 示例值 | 描述 |
|---|
| unit | String | ms | 性能指标单位。 |
level | Integer | 0
| 等级。 - 0：严重低于预期
- 1：略低于预期
- 2：符合预期
- 3：高于预期
|
| value | String | 1234 | 性能指标值。 |
| up_base_line | Double | 2500 | 性能指标基准线上限，在上下限之间属于符合预期。 |
| down_base_line | Double | 1001 | 性能指标基准线下限。 |
ChartData
| 参数 | 类型 | 示例值 | 描述 |
|---|
| fields | Array of Field | - | 折线图/饼图维度，len(fields)=len(source[i])。 |
| source | Array of String | [["1668355200","js_error","0","0"]] | 趋势图具体点的集合，len(source)为折线图点的数量或者饼图中块数量。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|
| type | String | count,rate | 性能指标值单位。 |
| benchmark | Double | 2005 | 性能指标基准线上限。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|
| up | Double | 2500 | 性能指标基准线上限。 |
| down | Double | 1001 | 性能指标基准线下限。 |
| label | String | avg，pct50，pct75，pct90，pct95 | 性能指标聚合方式。 |
| value | Double | 1234 | 性能指标聚合值。 |
| granularity | String | 50 | 分布图间隔性能指标值分布间隔。 |
Field
| 参数 | 类型 | 示例值 | 描述 |
|---|
| id | String | date | 维度key。 |
| name | String | 日期 | 维度名。 |
| dataType | String | string | 维度类型。 |
| aggregate | String | - | 聚合方式。 |
请求示例
POST https://open.volcengineapi.com/?Action=PageOverview&Version=2022-10-12
{
"time_filter": {
"start_time": 1665485413,
"end_time": 1665744613,
"granularity": 3600
},
"common": {
"aid": 12345,
"site_type": "web",
"env": "online",
"user": "test_user",
"os": "webpro"
},
"type": "avg",
"filter_conditions": {
"type": "and",
"children": [
{
"type": "and",
"groupKey": "context",
"op": "in",
"field": "pid",
"children": [],
"values": "[数据探索]"
}
],
"op": "in",
"values": "[数据探索]",
"field": "pid",
"groupKey": "context"
}
}
返回示例
{
"error_msg": "",
"data": [
{
"trend": {
"data": {
"fields": [
{
"id": "date",
"aggregate": "",
"name": "日期",
"dataType": "string"
}
],
"source": [
[
"1668355200",
"js_error",
"0",
"0"
]
]
},
"extra": {
"benchmark": 2005,
"type": "count,rate"
}
},
"status": {
"value": "1234",
"up_base_line": 2500,
"level": 0,
"unit": "ms",
"down_base_line": 1001
},
"desc": "",
"distribution": {
"extra": {
"value": 1234,
"down": 1001,
"label": "avg，pct50，pct75，pct90，pct95",
"up": 2500,
"granularity": "50"
},
"data": {
"fields": [
{
"aggregate": "",
"dataType": "string",
"name": "日期",
"id": "date"
}
],
"source": [
[
"1668355200",
"js_error",
"0",
"0"
]
]
}
},
"metric": "fp",
"bounce_rate": {
"data": {
"fields": [
{
"dataType": "string",
"name": "日期",
"aggregate": "",
"id": "date"
}
],
"source": [
[
"1668355200",
"js_error",
"0",
"0"
]
]
},
"extra": {
"benchmark": 2005,
"type": "count,rate"
}
}
}
],
"error_no": 0
}
错误码
本接口无特有的错误码。更多信息请参见错误码。