You need to enable JavaScript to run this app.
导航
应用性能监控全链路版
  • 文档首页
    • /应用性能监控全链路版/OpenAPI参考/WebPro端/JS错误监控/JSErrDetail
JSErrDetail
最近更新时间：2024.07.12 17:21:38首次发布时间：2022.11.18 15:32:34
我的收藏

获取JS错误详情。

请求说明

  • 请求方式：POST
  • 请求地址：https://open.volcengineapi.com/?Action=JSErrDetail&Version=2022-10-12
ServiceName: apmplus_openapi
Region: cn-beijing 
X-App-Ids: xxx
Content-Type: application/json

请求参数

Query

参数类型是否必选示例值描述
ActionString是JSErrDetail接口名称。当前 API 的名称为 JSErrDetail。
VersionString是2022-10-12接口版本。当前 API 的版本为 2022-10-12。

Body

参数类型是否必选示例值描述
commonObject of CommonParams是-通用参数。
time_filterObject of TimeFilter是-时间区间。
issue_idString是2769ad7223a4eaefffbe9b2f59bb933bjs错误聚合ID。
filter_conditionsObject of FilterCondition否-筛选条件。

CommonParams

参数类型是否必选示例值描述
aidLong是12345应用ID。
site_typeString是web站点类型。
envString是online环境，填""时为全部。
osString否webpro服务类型，可选值为webpro，app，minipro。
userString否test_user用户名。

TimeFilter

参数类型是否必选示例值描述
start_timeInteger是1665485413起始时间，单位s。
end_timeInteger是1665744613终止时间，单位s。
granularityInteger否3600聚合时间粒度，单位s。

FilterCondition

参数类型是否必选示例值描述
typeString是and筛选条件类型，可选值为and和rule，只支持两层，第一层的type必须为and，第二层的type必须为rule。
fieldString否pid条件字段key，可选值集合由GetFieldKeys方法获取。
opString否in条件符号，可选值有eq，neq，lt，lte，gt，gte，in，not_in，regex，not_regex。
groupKeyString否contextmap类型字段key，可选值集合由GetFieldKeys方法获取。
valuesArray of String否[数据探索]条件值，可选值集合由GetFieldValues方法获取。
childrenArray of FilterCondition否-如果下层还有条件，则放入该处，即type为and时必填。这一层与field，op，groupkey以及values不能同时存在。

返回参数

参数类型示例值描述
dataObject of JSErrDetail-JS错误详情。
error_msgString-错误信息，成功为空。
error_noInteger0错误码，成功为0。

JSErrDetail

参数类型示例值描述
nameString-错误名和信息错误类型。
messageStringError: message test错误信息。
filenameString12345.js报错文件名。
userLong10错误及用户数信息JS错误影响用户数。
countLong10JS错误数。
issue_idString1234567223a4eaefffbe9b2f59bb933bissue相关信息JS错误聚合ID。
issueObject of IssueInfo-issue状态操作issue分配信息。
min_crash_timeLong1668561659926所选时间区间内JS错误最早发生时间。
max_crash_timeLong1678561659926所选时间区间内JS错误最晚发生时间。
min_crash_releaseStringv1.2.3所选时间区间内JS错误最早出现版本。
max_crash_releaseStringv1.2.4所选时间区间内JS错误最晚出现版本。
min_crash_pidStringpid_1所选时间区间内JS错误最早出现页面。
max_crash_pidStringpid_2所选时间区间内JS错误最晚出现页面。
trendsObject of ChartData-JS错误趋势图。
extraObject of TrendExtra-JS错误额外信息。
release_distributionObject of ChartData-版本分布。
pid_distributionObject of ChartData-页面分布。
releasesArray of String-JS错误发生的版本列表。

IssueInfo

参数类型示例值描述
managersArray of IssueManager-issue处理人。
statusStringprocessingissue状态。
fixed_versionStringv1.1.2修复版本号。

ChartData

参数类型示例值描述
fieldsArray of Field-折线图/饼图维度，len(fields)=len(source[i])。
sourceArray of String[["1668355200","js_error","0","0"]]趋势图具体点的集合，len(source)为折线图点的数量或者饼图中块数量。

TrendExtra

参数类型示例值描述
release_infoArray of ReleaseInfo-版本发布情况。

IssueManager

参数类型示例值描述
nameStringtest_user处理人名。
emailStringtest_user@test.com处理人邮箱。
user_idLong12处理人ID。

Field

参数类型示例值描述
idStringdate维度key。
nameString日期维度名。
dataTypeStringstring维度类型。
aggregateString-聚合方式。

ReleaseInfo

参数类型示例值描述
envStringtest版本发布环境。
commitString[]版本相关commit。
releaseStringv2.2.123版本。
create_atInteger1668483578版本发布时间。

请求示例

POST https://open.volcengineapi.com/?Action=JSErrDetail&Version=2022-10-12
{
    "common": {
        "aid": 12345,
        "site_type": "web",
        "env": "online",
        "os": "webpro",
        "user": "test_user"
    },
    "time_filter": {
        "start_time": 1665485413,
        "end_time": 1665744613,
        "granularity": 3600
    },
    "issue_id": "2769ad7223a4eaefffbe9b2f59bb933b"
}

返回示例

{
    "data": {
        "extra": {
            "release_info": [
                {
                    "commit": "",
                    "create_at": 1668483578,
                    "env": "test",
                    "release": "v2.2.123"
                }
            ]
        },
        "release_distribution": {
            "source": [
                [
                    "1668355200",
                    "js_error",
                    "0",
                    "0"
                ]
            ],
            "fields": [
                {
                    "name": "日期",
                    "aggregate": "",
                    "dataType": "string",
                    "id": "date"
                }
            ]
        },
        "releases": [],
        "message": "Error: message test",
        "trends": {
            "source": [
                [
                    "1668355200",
                    "js_error",
                    "0",
                    "0"
                ]
            ],
            "fields": [
                {
                    "name": "日期",
                    "aggregate": "",
                    "id": "date",
                    "dataType": "string"
                }
            ]
        },
        "issue": {
            "fixed_version": "v1.1.2",
            "tag": [
                {
                    "key": "",
                    "id": 172,
                    "values": [
                        {
                            "value": "",
                            "id": 346
                        }
                    ]
                }
            ],
            "managers": [
                {
                    "head_url": "",
                    "email": "test_user@test.com",
                    "name": "test_user",
                    "user_id": 12
                }
            ],
            "status": "processing",
            "id": 944
        },
        "max_crash_pid": "pid_2",
        "meego_issue_url": "powerful",
        "issue_id": "1234567223a4eaefffbe9b2f59bb933b",
        "filename": "12345.js",
        "git_issue_url": "I'm",
        "user": 10,
        "count": 10,
        "min_crash_time": 1668561659926,
        "name": "together",
        "pid_distribution": {
            "fields": [
                {
                    "id": "date",
                    "dataType": "string",
                    "name": "日期",
                    "aggregate": ""
                }
            ],
            "source": [
                [
                    "1668355200",
                    "js_error",
                    "0",
                    "0"
                ]
            ]
        },
        "max_crash_release": "v1.2.4",
        "min_crash_release": "v1.2.3",
        "max_crash_time": 1678561659926,
        "min_crash_pid": "pid_1"
    },
    "error_no": 0,
    "error_msg": ""
}

错误码

本接口无特有的错误码。更多信息请参见错误码。