GetAppTrend

更新时间：2023.05.10 14:58:40

调用GetAppTrend接口获取App端崩溃分析、MetricKit、崩溃防护、自定义错误、卡顿分析相关数据的趋势，例如崩溃分析数、崩溃率、崩溃用户数、崩溃用户率、PV、UV。

使用说明

接口名称：GetAppTrend
请求方式：POST
接口地址：/?Action=GetAppTrend&Version=2022-10-12

请求参数

Query

参数	类型	是否必选	示例值	描述
Action	string	是	`GetAppTrend`	请求名称。
Version	string	是	`2022-10-12`	请求版本。

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

Body

参数	类型	是否必选	示例值	描述
aid	i32	否	`123456`	应用ID。
os	string	否	`Android`	操作系统。 Andriod iOS
start_time	i32	是	`1677772800`	开始时间。
end_time	i32	是	`1678442865`	终止时间。
compare_start_time	i32	否	`1677102735`	对比开始时间。开始时间和终止时间是一段时间窗口。对比开始时间和对比终止时间是另一段时间窗口，一般情况下，对比开始时间和对比终止时间的周期与开始时间和终止时间的周期相同，为开始时间之前的一段时间。例如，开始时间为2023-03-05 00:00:00，结束时间为2023-03-08 00:00:00。那么对比开始时间为2023-03-02 00:00:00，对比结束时间为2023-03-05 00:00:00。
compare_end_time	i32	否	`1677772800`	对比终止时间。一般情况下，对比终止时间就是开始时间。
biz_type	string	是	`crash`	异常类型。 crash：崩溃 crash_defend：崩溃防护 lag：卡顿 custom_exception：自定义异常 metric_kit：MetricKit
filters	object of filters	否	-	筛选条件。
granularity	i32	否	`1440`	聚合度，单位分钟。
group_by_field	string	否	-	分组字段，不分组的情况下传空字符串。
metric	string	是	`crash_count`	指标名。 crash_count：崩溃次数 crash_user：崩溃人数 crash_ratio：崩溃率 crash_user_ratio：崩溃用户比例 session_count：PV数 session_user：用户数
from	string	否	-	是否来自于其他模块。 startup：启动分析模块 app_page：页面分析模块
status	array of string	否	`pending`	issue状态，支持多个。 pending：未修复 processing：修复中 ignored：已忽略 solved：已修复 reopen：重复出现
crash_type	string	是	`anr`	崩溃类型。 java：Java崩溃 launch：Java启动崩溃 native：Native崩溃 anr：ANR crash：崩溃 watch_dog：卡死 oom_crash：OOM崩溃 extension：Extension崩溃
tags	array of string	否	-	标签。
token	string	否	-	搜索关键字。
is_new	i32	否	`0`	是否新增issue。 0：不是新增issue 1：是新增issue
managers	array of string	否	-	按责任人筛选，传用户ID列表。
time_type	string	否	-	时间类型。 api_time：上报时间（默认） event_time：发生时间
is_custom	boolean	否	`false`	是否是自定义维度。

filters

参数	类型	是否必选	示例值	描述
type	string	否	`and`	筛选条件类型。 expression：表达式 map：映射 and：且条件 or：或条件
op	string	否	`in`	操作符。 in：包含
dimension	string	否	`aid`	条件的名称。
values	array of string	否	`[123456]`	筛选值，支持多个。
value	string	否	`123456`	筛选值。
map_key	string	否	`key_1`	map类型的key，当type为map时必填。
sub_conditions	array of sub_conditions	否	-	子条件。

sub_conditions

参数	类型	是否必选	示例值	描述
type	string	否	`expression`	筛选条件类型。 expression：表达式 map：映射 and：且条件 or：或条件
op	string	否	`in`	操作符。 in：包含
dimension	string	否	`os`	条件的名称。
values	array of string	否	`[` `"Android"` `]`	筛选值，支持多个。
value	string	否	`123456`	筛选值。
map_key	string	否	`key_1`	map类型key，当type为map时必填。
sub_conditions	array of string	否	-	子条件。

返回参数

参数	类型	示例值	描述
data	string	-	key为指标名，对应request里的metric。不分组的请求下，list只有一个元素，分组情况下会有多个元素，每个元素代表一条线。
error_msg	string	-	错误信息。
error_no	i32	`0`	错误码。

示例

请求示例

POST https://open.volcengineapi.com/?Action=GetAppTrend&Version=2022-10-12 

{
    "aid":123456,
    "os":"Android",
    "start_time":1677772800,
    "end_time":1678442865,
    "compare_start_time":1677102735,
    "compare_end_time":1677772800,
    "granularity":1440,
    "status":[
        "pending"
    ],
    "filters":{
        "type":"and",
        "sub_conditions":[
            {
                "dimension":"os",
                "op":"in",
                "type":"expression",
                "values":[
                    "Android"
                ]
            }
        ]
    },
    "biz_type":"crash",
    "crash_type":"anr",
    "metric":"crash_count"
}

正常返回示例

{
    "err_detail":"",
    "data":[
        {
            "name":"",
            "points":[
                {
                    "timestamp":1677772800,
                    "readable_timestamp":"2023-03-03 00:00:00",
                    "value":61,
                    "alert":{
                        "alert":false,
                        "msg":""
                    }
                },
                {
                    "timestamp":1677859200,
                    "readable_timestamp":"2023-03-04 00:00:00",
                    "value":15,
                    "alert":{
                        "alert":false,
                        "msg":""
                    }
                },
                {
                    "timestamp":1677945600,
                    "readable_timestamp":"2023-03-05 00:00:00",
                    "value":23,
                    "alert":{
                        "alert":false,
                        "msg":""
                    }
                },
                {
                    "timestamp":1678032000,
                    "readable_timestamp":"2023-03-06 00:00:00",
                    "value":18,
                    "alert":{
                        "alert":false,
                        "msg":""
                    }
                },
                {
                    "timestamp":1678118400,
                    "readable_timestamp":"2023-03-07 00:00:00",
                    "value":24,
                    "alert":{
                        "alert":false,
                        "msg":""
                    }
                },
                {
                    "timestamp":1678204800,
                    "readable_timestamp":"2023-03-08 00:00:00",
                    "value":27,
                    "alert":{
                        "alert":false,
                        "msg":""
                    }
                },
                {
                    "timestamp":1678291200,
                    "readable_timestamp":"2023-03-09 00:00:00",
                    "value":47,
                    "alert":{
                        "alert":false,
                        "msg":""
                    }
                },
                {
                    "timestamp":1678377600,
                    "readable_timestamp":"2023-03-10 00:00:00",
                    "value":23,
                    "alert":{
                        "alert":false,
                        "msg":""
                    }
                }
            ],
            "total":238
        }
    ],
    "error_msg":"",
    "error_no":0
}

异常返回示例

{
    "ResponseMetadata": {
        "RequestId": "20180***80022D30",
        "Action": "GetAppTrend",
        "Version": "2022-10-12",
        "Service": "***",
        "Region": "cn-north-1",
        "Error": {
            "Code": "200000",
            "Message": "参数异常"
        }
    }

使用说明

请求参数

Query

Header

Body

filters

sub_conditions

返回参数

示例

请求示例

正常返回示例

异常返回示例

应用性能监控全链路版

GetAppTrend

使用说明 #

请求参数 #

Query #

Header #

Body #

filters #

sub_conditions #

返回参数 #

示例 #

请求示例 #

正常返回示例 #

异常返回示例 #

使用说明

请求参数

Query

Header

Body

filters

sub_conditions

返回参数

示例

请求示例

正常返回示例

异常返回示例