You need to enable JavaScript to run this app.
导航
GetAppTrend
最近更新时间:2024.07.15 16:31:28首次发布时间:2023.03.13 16:59:23

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

请求说明

  • 请求方式:POST
  • 请求地址:https://open.volcengineapi.com?Action=GetAppTrend&Version=2022-10-12
ServiceName: apmplus_openapi
Region: cn-beijing
X-App-Ids: xxx
Content-Type: application/json

请求参数

Query

参数类型是否必选示例值描述
ActionStringGetAppTrend接口名称。当前 API 的名称为 GetAppTrend
VersionString2022-10-12接口版本。当前 API 的版本为 2022-10-12

Body

参数类型是否必选示例值描述
aidLong123456应用ID。
start_timeLong1665417600开始时间。
end_timeLong1665504000终止时间。

biz_type

String

crash

异常类型。

  • crash:崩溃
  • crash_defend:崩溃防护
  • lag:卡顿
  • custom_exception:自定义异常
  • metric_kit:MetricKit
filtersObject of Condition-筛选条件,可以指定多个键值对来筛选数据。
granularityInteger1440聚合度,单位分钟。
group_by_fieldString-分组字段,不分组的情况下传空字符串。

metric

String

crash_count

指标名。

  • crash_count:崩溃次数
  • crash_user:崩溃人数
  • crash_ratio:崩溃率
  • crash_user_ratio:崩溃用户比例
  • session_count:PV数
  • session_user:用户数

from

String

startup

是否来自于其他模块。

  • startup:启动分析模块
  • app_page:页面分析模块

status

Array of String

pending

issue状态,支持多个。

  • pending:未修复
  • processing:修复中
  • ignored:已忽略
  • solved:已修复
  • reopen:重复出现
tagsArray of Long-标签。
tokenString-搜索关键字。

is_new

Integer

0

是否新增issue。

  • 0:不是新增issue
  • 1:是新增issue
managersArray of Long-按责任人筛选,传用户ID列表。

time_type

String

-

时间类型。

  • api_time:上报时间(默认)
  • event_time:发生时间
is_customBooleanfalse是否是自定义维度。
compare_start_timeLong1619740800对比时段起始时间的 Unix 时间戳
compare_end_timeLong1619827200对比时段结束时间的 Unix 时间戳

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类型。
valueStringAndroid筛选值。
valuesArray of String["Android"]筛选值,支持多个。
map_keyStringkey_1map类型key,当type为map时必填。
dimensionStringaid条件的名称。
sub_conditionsArray of Condition-子条件。

返回参数

参数类型示例值描述
dataArray of TrendLine-不分组的请求下,list只有一个元素,分组情况下会有多个元素,每个元素代表一条线。
error_msgString-错误信息。
error_noInteger0错误码。

TrendLine

参数类型示例值描述
nameStringtest线的名称,在分组的情况下,name应该是分组维度的取值,比如用来显示曲线的图标。
pointsArray of TrendPoint-曲线上的点。

TrendPoint

参数类型示例值描述
valueDouble0指标值。
timestampLong1653696000指标发生时间(Unix时间戳)。
readable_timestampString2022-05-28 08:00:00指标发生时间(自然时间)。

请求示例

POST https://open.volcengineapi.com?Action=GetAppTrend&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",
    "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
}

错误码

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