更新时间：2023.04.11 16:29:04
调用PageOverview接口获取页面性能指标总览。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
Action | String | 是 |
| 请求名称。 |
Version | String | 是 |
| 请求版本。 |
ServiceName : apmplus_openapi Region : cn-beijing X-App-Ids : xxx Content-Type : application/json
参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
time_filter | object of time_filter | 是 | - | 时间区间。 |
common | object of common | 是 | - | 通用参数。 |
filter_conditions | object of filter_conditions | 否 | - | 筛选条件。 |
type | string | 是 |
| 性能指标聚合方式。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
start_time | i32 | 是 |
| 起始时间，单位s。 |
granularity | i32 | 否 |
| 聚合时间粒度，单位s。 |
end_time | i32 | 是 |
| 终止时间，单位s。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
aid | i64 | 是 |
| 应用ID。 |
site_type | string | 是 |
| 站点类型。 |
env | string | 是 |
| 环境，填""时为全部。 |
os | string | 否 |
| 服务类型，可选值为webpro，app，minipro。 |
user | string | 否 |
| 用户名。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
type | string | 是 |
| 筛选条件类型，可选值为and和rule，只支持两层，第一层的type必须为and，第二层的type必须为rule。 |
field | string | 否 |
| 条件字段key，可选值集合由 |
op | string | 否 |
| 条件符号，可选值有eq，neq，lt，lte，gt，gte，in，not_in，regex，not_regex。 |
groupKey | string | 否 |
| map类型字段key，可选值集合由 |
values | array of string | 否 |
| 条件值，可选值集合由 |
children | array of children | 否 | - | 如果下层还有条件，则放入该处，这一层与field，op，groupkey以及values不能同时存在。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
type | string | 是 |
| 筛选条件类型，可选值为and和rule，只支持两层，第一层的type必须为and，第二层的type必须为rule。 |
field | string | 否 |
| 条件字段key，可选值集合由 |
op | string | 否 |
| 条件符号，可选值有eq，neq，lt，lte，gt，gte，in，not_in，regex，not_regex。 |
groupKey | string | 否 |
| map类型字段key，可选值集合由 |
values | array of string | 否 |
| 条件值，可选值集合由 |
children | array of string | 否 | - | 如果下层还有条件，则放入该处，这一层与field，op，groupkey以及values不能同时存在。 |
参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
data | array of data | - | 性能指标总览情况。 |
error_msg | string | - | 错误信息，成功为空。 |
error_no | i32 |
| 错误码，成功为0。 |
参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
metric | string |
| 性能指标key。 |
desc | string | - | 性能指标描述。 |
status | object of status | - | 性能指标值状态评估，符合预期，高于预期或低于预期。 |
trend | object of trend | - | 性能指标值变化趋势。 |
bounce_rate | object of bounce_rate | - | 性能指标跳出率变化趋势。 |
distribution | object of distribution | - | 性能指标值分布。 |
参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
level | i8 |
| 等级。
|
unit | string |
| 性能指标单位。 |
value | string |
| 性能指标值。 |
down_base_line | double |
| 性能指标基准线下限。 |
up_base_line | double |
| 性能指标基准线上限，在上下限之间属于符合预期。 |
参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
data | object of data | - | 性能指标值变化趋势。 |
extra | object of extra | - | 性能指标值额外信息。 |
参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
data | object of data | - | 性能指标值变化趋势。 |
extra | object of extra | - | 性能指标值额外信息。 |
参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
data | object of data | - | 性能指标值分布。 |
extra | object of extra | - | 性能指标聚合值。 |
参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
fields | array of fields | - | 折线图/饼图维度，len(fields)=len(source[i])。 |
source | array of string |
| 趋势图具体点的集合，len(source)为折线图点的数量或者饼图中块数量。 |
参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
benchmark | double |
| 性能指标基准线上限。 |
type | string |
| 性能指标值单位。 |
参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
label | string |
| 性能指标聚合方式。 |
value | double |
| 性能指标聚合值。 |
up | double |
| 性能指标基准线上限。 |
down | double |
| 性能指标基准线下限。 |
granularity | string |
| 分布图间隔性能指标值分布间隔。 |
参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
id | string |
| 维度key。 |
dataType | string |
| 维度类型。 |
name | 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 }
{ "ResponseMetadata": { "RequestId": "201806041104200100100232280022D30", "Action": "PageOverview", "Version": "2022-10-12", "Service": "***", "Region": "cn-north-1", "Error": { "Code": "200000", "Message": "参数异常" } } }