获取性能劣化top5页面列表。
请求说明
- 请求方式：POST
- 请求地址：https://open.volcengineapi.com/?Action=DeteriorationPerf&Version=2022-10-12
ServiceName: apmplus_openapi
Region: cn-beijing
X-App-Ids: xxx
Content-Type: application/json
请求参数
Query
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|
| Action | String | 是 | DeteriorationPerf | 接口名称。当前 API 的名称为 DeteriorationPerf。 |
| Version | String | 是 | 2022-10-12 | 接口版本。当前 API 的版本为 2022-10-12。 |
Body
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|
| time_filter | Object of TimeFilter | 是 | - | 时间区间。 |
| common | Object of CommonParams | 是 | - | 通用参数。 |
| filter_conditions | Object of FilterCondition | 否 | - | 筛选条件。 |
| metric | String | 是 | fp | 排序性能指标key。支持按照fp、fcp、fmp、tti、load和lcp。 |
| type | String | 否 | avg | 排序性能指标聚合方式。支持的聚合方式有avg、pct50、pct75、pct90和pct95。 |
| min_count | Integer | 否 | 1 | 样本量阈值，低于阈值的页面不参与计算。 |
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不能同时存在。 |
返回参数
| 参数 | 类型 | 示例值 | 描述 |
|---|
| data | Array of PerfChangeItem | - | 性能优化/劣化top5页面列表。 |
| error_msg | String | - | 错误信息，成功为空。 |
| error_no | Integer | 0 | 错误码，成功为0。 |
PerfChangeItem
| 参数 | 类型 | 示例值 | 描述 |
|---|
| to | Long | 2345 | 所选时间区间下半时间周期性能指标值。 |
| pid | String | path_test | 页面ID。 |
| from | Long | 1234 | 所选时间区间上半时间周期性能指标值。 |
| extra | Object of TrendExtra | - | 所选时间区间内的版本发布情况。 |
| trend | Object of ChartData | - | 性能指标变化趋势。 |
ChartData
| 参数 | 类型 | 示例值 | 描述 |
|---|
| fields | Array of Field | - | 折线图/饼图维度，len(fields)=len(source[i])。 |
| source | Array of String | [["1668355200","js_error","0","0"]] | 趋势图具体点的集合，len(source)为折线图点的数量或者饼图中块数量。 |
ReleaseInfo
| 参数 | 类型 | 示例值 | 描述 |
|---|
| env | String | test | 版本发布环境。 |
| commit | String | [] | 版本相关commit。 |
| release | String | v2.2.123 | 版本。 |
| create_at | Integer | 1668483578 | 版本发布时间。 |
Field
| 参数 | 类型 | 示例值 | 描述 |
|---|
| id | String | date | 维度key。 |
| name | String | 日期 | 维度名。 |
| dataType | String | string | 维度类型。 |
| aggregate | String | - | 聚合方式。 |
请求示例
POST https://open.volcengineapi.com/?Action=DeteriorationPerf&Version=2022-10-12
{
"time_filter": {
"start_time": 1665485413,
"end_time": 1665744613,
"granularity": 3600
},
"common": {
"aid": 12345,
"site_type": "web",
"env": "online",
"os": "webpro",
"user": "test_user"
},
"metric": "fp，fcp,fmp,tti,load,lcp",
"type": "avg,pct50,pct75,pct90,pct95",
"filter_conditions": {
"type": "and",
"children": [
{
"type": "and",
"op": "in",
"field": "pid",
"values": "[数据探索]",
"groupKey": "context",
"children": []
}
],
"op": "in",
"groupKey": "context",
"field": "pid",
"values": "[数据探索]"
},
"min_count": 1
}
返回示例
{
"error_msg": "",
"error_no": 0,
"data": [
{
"trend": {
"source": [
[
"1668355200",
"js_error",
"0",
"0"
]
],
"fields": [
{
"id": "date",
"aggregate": "",
"name": "日期",
"dataType": "string"
}
]
},
"to": 2345,
"pid": "path_test",
"extra": {
"release_info": [
{
"create_at": 1668483578,
"env": "test",
"release": "v2.2.123",
"commit": ""
}
]
},
"from": 1234
}
]
}
错误码
本接口无特有的错误码。更多信息请参见错误码。