获取指定Action下发生的JS错误列表。
请求说明
- 请求方式：POST
- 请求地址：https://open.volcengineapi.com/?Action=GetJsErrorListPerAction&Version=2022-10-12
ServiceName: apmplus_openapi
Region: cn-beijing
X-App-Ids: xxx
Content-Type: application/json
请求参数
Query
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|
| Action | String | 是 | GetJsErrorListPerAction | 接口名称。当前 API 的名称为 GetJsErrorListPerAction。 |
| Version | String | 是 | 2022-10-12 | 接口版本。当前 API 的版本为 2022-10-12。 |
Body
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|
| action_type | String | 是 | click | Action类型。调用GetActionOverviewList接口查看取值。 |
| pid | String | 是 | 数据探索 | 页面ID。调用GetActionOverviewList接口查看取值。 |
| action_target_name | String | 是 | 描述 | Action名字。调用GetActionOverviewList接口查看取值。 |
| common | Object of CommonParams | 是 | - | 通用参数。 |
| time_filter | Object of TimeFilter | 是 | - | 时间区间。 |
| filter_conditions | Object of FilterCondition | 否 | - | 筛选条件。 |
order_by | String | 否 | count_descend
| 排序依据。 - count_ascend：升序排列
- count_descend（默认）：降序排列
|
| pgno | Long | 否 | 1 | 分页查询参数，用于设置当前页码。 |
| pgsz | Long | 否 | 10 | 分页查询参数，用于设置每页行数。 |
CommonParams
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|
| aid | Long | 是 | 12345 | 应用ID。 |
| site_type | String | 是 | web | 站点类型。 |
| env | String | 是 | online | 环境，填""时为全部。 |
| os | String | 否 | webpro | 服务类型，可选值为webpro，app，minipro。 |
| user | String | 否 | test_user | 用户名。 |
TimeFilter
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|
| start_time | Integer | 是 | 1665485413 | 起始时间，单位s。 |
| end_time | Integer | 是 | 1665744613 | 终止时间，单位s。 |
| granularity | Integer | 否 | 3600 | 聚合时间粒度，单位s。 |
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不能同时存在。 |
返回参数
OverviewErrorListResponseData
| 参数 | 类型 | 示例值 | 描述 |
|---|
| total | Long | 10 | JS错误聚类总数。 |
| result | Array of ErrorListItem | - | JS错误聚合列表。 |
ErrorListItem
| 参数 | 类型 | 示例值 | 描述 |
|---|
| message | String | Minified React error | 错误信息。 |
| name | String | Error | 错误类型。 |
| filename | String | 12345.js | 报错文件名。 |
| issue_id | String | 12345 | issue状态操作。 |
| issue | Object of IssueInfo | - | issue分配信息。 |
| meego_issue_url | String | - | 如果issue_status不为done，则不设置这个字段。 |
| level | String | - | 起止时间。 |
| max_crash_time | Long | 1667441262510 | 当前所选时间区间内JS错误最晚出现时间。 |
| min_crash_time | Long | 1666781177513 | 错误及用户数信息。 |
| count | Long | 10 | 错误及用户数信息错误数。 |
| count_mini_chart | Object of ChartData | - | 错误数趋势。 |
| user | Long | 10 | 影响用户数。 |
| user_mini_chart | Object of ChartData | - | 影响用户数趋势。 |
IssueInfo
| 参数 | 类型 | 示例值 | 描述 |
|---|
| managers | Array of IssueManager | - | issue处理人。 |
| status | String | processing | issue状态。 |
| fixed_version | String | v1.1.2 | 修复版本号。 |
ChartData
| 参数 | 类型 | 示例值 | 描述 |
|---|
| fields | Array of Field | - | 折线图/饼图维度，len(fields)=len(source[i])。 |
| source | Array of String | [["1668355200","js_error","0","0"]] | 趋势图具体点的集合，len(source)为折线图点的数量或者饼图中块数量。 |
IssueManager
| 参数 | 类型 | 示例值 | 描述 |
|---|
| name | String | test_user | 处理人名。 |
| email | String | test_user@test.com | 处理人邮箱。 |
| user_id | Long | 12 | 处理人ID。 |
Field
| 参数 | 类型 | 示例值 | 描述 |
|---|
| id | String | date | 维度key。 |
| name | String | 日期 | 维度名。 |
| dataType | String | string | 维度类型。 |
| aggregate | String | - | 聚合方式。 |
请求示例
POST https://open.volcengineapi.com/?Action=GetJsErrorListPerAction&Version=2022-10-12
{
"common":{
"aid":12345
},
"time_filter":{
"start_time":1664621845,
"end_time":1665140253,
"granularity":86400
},
"action_type":"click",
"pid":"数据探索",
"action_target_name":"描述",
"metric_type":"avg",
"filter_conditions":{
"type":"and",
"children":[
{
"op":"in",
"field":"pid",
"values":[
"数据探索"
]
}
]
},
"pgsz":20,
"pgno":1,
"order_by":"count_descend"
}
返回示例
{
"err_detail":"",
"data":{
"measure_category_meta_list":[
{
"key":"pageview",
"label":"用户分析",
"type":"simple",
"measure_meta_list":[
{
"key":"",
"type":"basic",
"label":"PV",
"short_label":"",
"measure_name":"pv_uv.count"
},
{
"key":"",
"type":"basic",
"label":"UV",
"short_label":"",
"measure_name":"pv_uv.user"
},
{
"key":"",
"type":"basic",
"label":"Session 数",
"short_label":"",
"measure_name":"pv_uv.session_count"
}
]
}
]
},
"error_msg":"",
"error_no":0
}
错误码
本接口无特有的错误码。更多信息请参见错误码。