MiniProJsTrendOverview--应用性能监控全链路版-火山引擎

文档中心

立即注册

导航

MiniProJsTrendOverview

最近更新时间：2024.07.15 15:52:20首次发布时间：2024.04.03 17:37:04

查看JS错误趋势总览。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com?Action=MiniProJsTrendOverview&Version=2024-03-12

请求参数

ServiceName : apmplus_openapi 
Region : cn-beijing 
X-App-Ids : xxx 
Content-Type : application/json

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`MiniProJsTrendOverview`	接口名称。当前 API 的名称为 `MiniProJsTrendOverview`。
Version	String	是	`2024-03-12`	接口版本。当前 API 的版本为 `2024-03-12`。

Body

参数	类型	是否必选	示例值	描述
common	Object of Common	是	`-`	通用参数。
time_filter	Object of TimeFilter	是	`-`	时间区间。
filter_conditions	Object of FilterConditions	否	`-`	筛选条件。

Common

参数	类型	是否必选	示例值	描述
aid	Long	是	`12345`	应用ID。
site_type	String	是	`web`	站点类型。
env	String	是	`online`	环境，填""时为全部。
os	String	否	`webpro`	服务类型。可选值为app，webpro，minipro。
user	String	否	`test_user`	用户名。

TimeFilter

参数	类型	是否必选	示例值	描述
start_time	Integer	是	`1665485413`	起始时间。单位s。
granularity	Integer	否	`3600`	聚合时间粒度。单位s。
end_time	Integer	是	`1665744613`	终止时间。单位s。

FilterConditions

参数类型是否必选示例值描述

参数	类型	是否必选	示例值	描述
type	String	是	`and`	筛选条件类型。 and：children中的条件为“与”关系。 rule：当前条件为原子条件。只支持两层，第一层的type必须为and，第二层的type必须为rule。
children	Array of Children	否	`-`	子参数。当type值为`and`时必填。

type

String

是

and

筛选条件类型。

and：children中的条件为“与”关系。
rule：当前条件为原子条件。
只支持两层，第一层的type必须为and，第二层的type必须为rule。

children Array of Children 否 - 子参数。当type值为and时必填。

Children

参数	类型	是否必选	示例值	描述
type	String	是	`rule`	筛选条件类型。 and：children中的条件为“与”关系。 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 Children	否	`-`	筛选条件类型。 and：children中的条件为“与”关系。 rule：当前条件为原子条件。只支持两层，第一层的type必须为and，第二层的type必须为rule。

返回参数

参数	类型	示例值	描述
data	Object of Data	`-`	总览趋势。
error_no	Integer	`0`	错误码。0为成功。
error_msg	String	`-`	错误信息。空为成功。

Data

参数	类型	示例值	描述
chart	Object of Chart	`-`	自定义事件上报趋势。
info	Array of Info	`-`	自定义事件总览值。
extra	Object of Extra	`-`	自定义事件额外信息。

Chart

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

Info

参数	类型	示例值	描述
id	String	`count`	汇总值key。
name	String	`白屏数`	汇总值名。
count	String	`1`	汇总值。
unit	String	`ms`	汇总单位。
change	String	`1.0`	环比。

Extra

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

Fields

参数	类型	示例值	描述
id	String	`date`	维度key。
dataType	String	`string`	维度类型。
name	String	`日期`	维度名。
aggregate	String	`-`	聚合方式。

ReleaseInfo

参数	类型	示例值	描述
create_at	Integer	`1668483578`	版本发布时间。
release	String	`v2.2.123`	版本。
env	String	`test`	版本发布环境。
commit	String	`[]`	版本相关commit。

请求示例

POST https://open.volcengineapi.com?Action=MiniProJsTrendOverview&Version=2024-03-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"
            }
        ]
    }
}

错误码

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

应用性能监控全链路版