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

文档中心

导航

GetAppSummaryData

最近更新时间：2024.09.11 14:33:07首次发布时间：2023.03.13 16:59:23

获取App端崩溃分析、MetricKit、崩溃防护、自定义错误、卡顿分析相关数据的数值，例如崩溃数、崩溃率、崩溃用户数、崩溃用户率数值。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com?Action=GetAppSummaryData&Version=2022-10-12

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

请求参数

Query

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

Body

参数	类型	是否必选	示例值	描述
aid	Long	否	`123456`	应用 ID。
start_time	Long	是	`1665417600`	开始时间。
end_time	Long	是	`1665504000`	终止时间。
biz_type	String	是	`crash`	异常类型。 crash：崩溃 crash_defend：崩溃防护 lag：卡顿 custom_exception：自定义异常 metric_kit：MetricKit
filters	Object of Condition	否	`-`	筛选条件，可以指定多个键值对来筛选数据。
compare_start_time	Long	否	`1665331200`	对比开始时间。开始时间和终止时间是一段时间窗口。对比开始时间和对比终止时间是另一段时间窗口，一般情况下，对比开始时间和对比终止时间的周期与开时间和终止时间的周期相同，为开始时间之前的一段时间。例如，开始时间为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	Long	否	`1665417600`	对比终止时间。一般情况下，对比终止时间就是开始时间。
status	Array of String	否	`pending`	issue状态，支持多个。 pending：未修复 processing：修复中 ignored：已忽略 solved：已修复 reopen：重复出现
tags	Array of Long	否	`-`	标签。
token	String	否	`-`	搜索关键字。
is_new	Integer	否	`0`	是否新增issue。 0：不是新增issue 1：是新增issue
managers	Array of Long	否	`-`	按责任人筛选，传用户ID列表。
time_type	String	否	`-`	时间类型。 api_time：上报时间（默认） event_time：发生时间

Condition

参数	类型	是否必选	示例值	描述
op	String	否	`in`	操作符。 gt：大于 gte：大于等于 lt：小于 lte：小于等于 eq：等于 neq：不等于 in：包含 not_in：不包含 lk：模糊匹配特定模式的数据 nlk：排除模糊匹配的数据
type	String	否	`expression`	筛选条件类型。 expression：当前condition是一个表达式。 and：当前condition是一个复合表达式，多个sub_condition的逻辑关系是and。 or：当前condition是一个复合表达式，多个sub_condition的逻辑关系是or。 map：当前condition是map类型。
value	String	否	`Android`	筛选值。
values	Array of String	否	`["Android"]`	筛选值，支持多个。
map_key	String	否	`key_1`	map类型key，当type为map时必填。
dimension	String	否	`aid`	条件的名称。
sub_conditions	Array of Condition	否	`-`	子条件。

返回参数

参数	类型	示例值	描述
data	Object of SummaryResponseData	`-`	返回数据。
error_msg	String	`-`	错误信息。
error_no	Integer	`0`	错误码。

SummaryResponseData

参数	类型	示例值	描述
crash_user	Object of SummaryMetric	`-`	崩溃用户数。
crash_count	Object of SummaryMetric	`-`	崩溃数。
crash_ratio	Object of SummaryMetric	`-`	崩溃率。
crash_user_ratio	Object of SummaryMetric	`-`	崩溃用户率。
avg_process_cpu_rate	Object of SummaryMetric	`-`	CPU平均进程CPU使用率。
cpu_report_cnt_per_lanuch	Object of SummaryMetric	`-`	CPU单次启动平均上报次数。
cpu_exception_user_all_rate	Object of SummaryMetric	`-`	CPU整体影响用户比。
cpu_exception_user_avg_rate	Object of SummaryMetric	`-`	CPU平均影响用户比。

SummaryMetric

参数	类型	示例值	描述
compare	Double	`300`	对比值。
current	Double	`238`	当前值。
rate	Double	`-0.20666666666666667`	变化率。变化率 =（当前值 - 对比值）/ 对比值

请求示例

POST https://open.volcengineapi.com?Action=GetAppSummaryData&Version=2022-10-12
{
    "aid":123456,
    "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"
}

返回示例

{
    "err_detail":"",
    "data":{
        "crash_count":{
            "current":238,
            "compare":300,
            "rate":-0.20666666666666667
        },
        "crash_user":{
            "current":81,
            "compare":98,
            "rate":-0.17346938775510204
        }
    },
    "error_msg":"",
    "error_no":0
}

错误码

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

应用性能监控全链路版

请求说明

Header

请求参数

Query

Body

Condition

返回参数

SummaryResponseData

SummaryMetric

请求示例

返回示例

错误码