You need to enable JavaScript to run this app.
导航
GetAppSummaryData
最近更新时间:2024.03.18 17:07:32首次发布时间:2023.03.13 16:59:23

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

使用说明

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

请求参数

Query

参数

类型

是否必选

示例值

描述

Action

string

GetAppSummaryData

请求名称。

Version

string

2022-10-12

请求版本。

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

Body

参数

类型

是否必选

示例值

描述

aid

i32

123456

应用ID。

start_time

i32

1677772800

开始时间。

end_time

i32

1678442865

终止时间。

biz_type

string

crash

异常类型。

  • crash:崩溃
  • crash_defend:崩溃防护
  • lag:卡顿
  • custom_exception:自定义异常
  • metric_kit:MetricKit

filters

object of filters

-

筛选条件。

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

对比终止时间。
一般情况下,对比终止时间就是开始时间。

status

array of string

pending

issue状态,支持多个。

  • pending:未修复
  • processing:修复中
  • ignored:已忽略
  • solved:已修复
  • reopen:重复出现

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:发生时间

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

object of data

-

返回数据。

error_msg

string

-

错误信息。

error_no

i32

0

错误码。

data

参数

类型

示例值

描述

crash_count

object of crash_count

-

崩溃数。
具体参数,请参见参数说明表

crash_user

object of crash_user

-

崩溃用户数。
具体参数,请参见参数说明表

cpu_exception_user_avg_rate

object of cpu_exception_user_avg_rate

-

CPU平均影响用户比。
具体参数,请参见参数说明表

cpu_exception_user_all_rate

object of cpu_exception_user_all_rate

-

CPU整体影响用户比。
具体参数,请参见参数说明表

cpu_report_cnt_per_lanuch

object of cpu_report_cnt_per_lanuch

-

CPU单次启动平均上报次数。
具体参数,请参见参数说明表

avg_process_cpu_rate

object of avg_process_cpu_rate

-

CPU平均进程使用率。
具体参数,请参见参数说明表

参数说明表

参数

类型

示例值

描述

current

double

238

当前值。

compare

double

300

对比值。

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
}

异常返回示例

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