You need to enable JavaScript to run this app.
导航
GetAppStartupMultiTrend
最近更新时间:2024.06.20 17:40:47首次发布时间:2023.03.13 16:59:23

调用GetAppStartupMultiTrend接口获取App启动分析的趋势。

请求说明

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

请求参数

Query

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

Body

参数类型是否必选示例值描述
start_timeInteger1665417600开始时间。
end_timeInteger1665504000终止时间。
filtersObject of Condition-筛选条件,可以指定多个键值对来筛选数据。
granularityInteger聚合度,单位分钟。
group_by_fieldString分组字段,不分组的情况下传空字符串。

metrics

Array of String

startup_count

指标列表。

  • startup_count:启动数量
  • startup_time_avg:启动时间平均值
  • time_pct50:启动时间50分位
  • time_pct75:启动时间75分位
  • time_pct95:启动时间95分位
  • time_pct99:启动时间99分位

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-子条件。

返回参数

参数类型示例值描述

data

JSON Map

-

错误返回数据。
key为指标名,对应request里的metric不分组的请求下,list只有一个元素,分组情况下会有多个元素,每个元素代表趋势图里的一条线。

error_msgString-错误信息。
error_noInteger0错误码。

Data

参数类型示例值描述
keyString
valueArray of TrendLine

TrendLine

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

TrendPoint

参数类型示例值描述
alertObject of AlertPoint-提示信息。
valueDouble123指标值。
timestampLong1665417600指标发生时间(Unix时间戳)。
readable_timestampString2022-10-11指标发生时间(自然时间)。

AlertPoint

参数类型示例值描述
msgStringNo error提示信息。
alertBooleantrue是否需要提示。

请求示例

POST https://open.volcengineapi.com?Action=GetAppStartupMultiTrend&Version=2022-10-12
{
    "start_time":1678032000,
    "end_time":1678674278,
    "filters":{
        "type":"and",
        "sub_conditions":[
            {
                "dimension":"os",
                "op":"in",
                "type":"expression",
                "values":[
                    "Android"
                ]
            }
        ]
    },
    "granularity":1440,
    "metrics":[
        "startup_count"
    ]
}

返回示例

{
    "err_detail":"",
    "data":{
        "startup_count":[
            {
                "name":"",
                "points":[
                    {
                        "timestamp":1678032000,
                        "readable_timestamp":"2023-03-06 00:00:00",
                        "value":687,
                        "alert":{
                            "alert":false,
                            "msg":""
                        }
                    },
                    {
                        "timestamp":1678550400,
                        "readable_timestamp":"2023-03-12 00:00:00",
                        "value":937,
                        "alert":{
                            "alert":false,
                            "msg":""
                        }
                    },
                    {
                        "timestamp":1678636800,
                        "readable_timestamp":"2023-03-13 00:00:00",
                        "value":411,
                        "alert":{
                            "alert":false,
                            "msg":""
                        }
                    }
                ],
                "total":5872
            }
        ]
    },
    "error_msg":"",
    "error_no":0
}

错误码

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