获取JS错误详情分布。
请求说明
- 请求方式：POST
- 请求地址：https://open.volcengineapi.com?Action=MiniProJsErrDetailDistribution&Version=2024-03-12
请求参数
ServiceName : apmplus_openapi
Region : cn-beijing
X-App-Ids : xxx
Content-Type : application/json
Query
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|
| Action | String | 是 | MiniProJsErrDetailDistribution | 接口名称。当前 API 的名称为 MiniProJsErrDetailDistribution。 |
| Version | String | 是 | 2024-03-12 | 接口版本。当前 API 的版本为 2024-03-12。 |
Body
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|
| common | Object of Common | 是 | - | 通用参数。 |
| time_filter | Object of TimeFilter | 是 | - | 时间区间。 |
| issue_id | String | 是 | 2769ad7223a4eaefffbe9b2f59bb933b | JS错误聚合ID。 |
Common
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|
| aid | Long | 是 | 12345 | 应用ID。 |
| site_type | String | 是 | web | 站点类型。 |
| env | String | 是 | online | 环境，填""时为全部。 |
| os | String | 否 | minipro | 服务类型，可选值为webpro，app，minipro。 |
| user | String | 否 | test_user | 用户名。 |
TimeFilter
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|
| start_time | Integer | 是 | 1665485413 | 起始时间，单位s。 |
| granularity | Integer | 否 | 3600 | 聚合时间粒度，单位s。 |
| end_time | Integer | 是 | 1665744613 | 终止时间，单位s。 |
返回参数
| 参数 | 类型 | 示例值 | 描述 |
|---|
| data | Object of Data | - | JS错误详情。 |
| error_msg | String | - | 错误信息。空为成功。 |
| error_no | Integer | 0 | 错误码。0为成功。 |
Data
| 参数 | 类型 | 示例值 | 描述 |
|---|
| distributions | JSON Map | - | 页面分布。 |
Distributions
| 参数 | 类型 | 示例值 | 描述 |
|---|
| key | String | | |
| value | Object of Value | | |
Value
| 参数 | 类型 | 示例值 | 描述 |
|---|
| fields | Array of Fields | - | 折线图/饼图维度，len(fields)=len(source[i])。 |
| source | Array of String | [["1668355200","js_error","0","0"]] | 趋势图具体点的集合，len(source)为折线图点的数量或者饼图中块数量。 |
Fields
| 参数 | 类型 | 示例值 | 描述 |
|---|
| id | String | date | 维度key。 |
| dataType | String | string | 维度类型。 |
| name | String | 日期 | 维度名。 |
| aggregate | String | - | 聚合方式。 |
请求示例
POST https://open.volcengineapi.com?Action=MiniProJsErrDetailDistribution&Version=2024-03-12
{
"time_filter": {
"start_time": 1711713122,
"end_time": 1711972322,
"granularity": 10800
},
"common": {
"site_type": "wx",
"env": "release",
"aid": 392926
},
"issue_id": "733f3d3463ebf7c8c3fea026f47c2941",
"dims": [
"pid",
"release"
]
}
返回示例
{
"err_detail": "",
"data": {
"distributions": {
"pid": {
"fields": [
{
"id": "pid",
"dataType": "string",
"name": "pid"
},
{
"id": "js_error.count",
"dataType": "number",
"name": "错误数"
}
],
"source": [
[
"page overview",
"415"
],
[
"page home",
"460"
],
[
"page monitor",
"437"
],
[
"page index",
"445"
]
]
},
"release": {
"fields": [
{
"id": "release",
"dataType": "string",
"name": "release"
},
{
"id": "js_error.count",
"dataType": "number",
"name": "错误数"
}
],
"source": [
[
"1.0.81",
"1757"
]
]
}
}
},
"error_msg": "",
"error_no": 0
}
错误码
本接口无特有的错误码。更多信息请参见错误码。