最近更新时间:2023.04.11 16:29:03
首次发布时间:2022.11.18 15:32:34
调用JSOverviewTrend接口获取js错误总览值及趋势。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 |
| 请求名称。 |
Version | String | 是 |
| 请求版本。 |
ServiceName : apmplus_openapi Region : cn-beijing X-App-Ids : xxx Content-Type : application/json
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
common | object of common | 是 | - | 通用参数。 |
time_filter | object of time_filter | 是 | - | 时间区间。 |
filter_conditions | object of filter_conditions | 否 | - | 筛选条件。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
aid | i64 | 是 |
| 应用ID。 |
site_type | string | 是 |
| 站点类型。 |
env | string | 是 |
| 环境,填""时为全部。 |
os | string | 否 |
| 服务类型,可选值为webpro,app,minipro。 |
user | string | 否 |
| 用户名。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
start_time | i32 | 是 |
| 起始时间,单位s。 |
granularity | i32 | 否 |
| 聚合时间粒度,单位s。 |
end_time | i32 | 是 |
| 终止时间,单位s。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
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 | object of data | - | 总览趋势。 |
error_no | i32 |
| 错误码,成功为0。 |
error_msg | string | - | 错误信息,成功为空。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
chart | object of chart | - | 自定义事件上报趋势。 |
info | array of info | - | 自定义事件总览值。 |
extra | object of extra | - | 自定义事件额外信息。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
fields | array of fields | - | 折线图/饼图维度,len(fields)=len(source[i])。 |
source | array of string |
| 趋势图具体点的集合,len(source)为折线图点的数量或者饼图中块数量。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
id | string |
| 汇总值key。 |
name | string |
| 汇总值名。 |
count | string |
| 汇总值。 |
unit | string |
| 汇总值单位 |
change | string |
| 环比。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
release_info | array of release_info | - | 版本发布情况。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
id | string |
| 维度key。 |
dataType | string |
| 维度类型。 |
name | string |
| 维度名。 |
aggregate | string | - | 聚合方式。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
create_at | i32 |
| 版本发布时间。 |
release | string |
| 版本。 |
env | string |
| 版本发布环境。 |
commit | string |
| 版本相关commit。 |
POST https://open.volcengineapi.com/?Action=JSOverviewTrend&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 }, "filter_conditions": { "type": "and", "op": "in", "children": [ { "type": "and", "children": [ { "type": "and", "values": "[数据探索]", "field": "pid", "groupKey": "context", "op": "in", "children": [] } ], "op": "in", "field": "pid", "values": "[数据探索]", "groupKey": "context" } ], "field": "pid", "groupKey": "context", "values": "[数据探索]" } }
{ "error_msg": "", "error_no": 0, "data": { "chart": { "source": [ [ "1668355200", "js_error", "0", "0" ] ], "fields": [ { "dataType": "string", "name": "日期", "aggregate": "", "id": "date" } ] }, "extra": { "release_info": [ { "env": "test", "create_at": 1668483578, "release": "v2.2.123", "commit": "" } ] }, "info": [ { "count": "1", "unit": "ms", "id": "count", "name": "白屏数", "change": "1" } ] } }
{ "ResponseMetadata": { "RequestId": "201806041104200100100232280022D30", "Action": "JSOverviewTrend", "Version": "2022-10-12", "Service": "***", "Region": "cn-north-1", "Error": { "Code": "200000", "Message": "参数异常" } } }