You need to enable JavaScript to run this app.
导航
GetAppBatteryPageList
最近更新时间:2024.06.18 17:22:42首次发布时间:2024.04.25 17:57:50

获取App电量前台列表。

请求说明

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

请求参数

Query

参数类型是否必选示例值描述
ActionStringGetAppBatteryPageList接口名称。当前 API 的名称为 GetAppBatteryPageList
VersionString2024-04-09接口版本。当前 API 的版本为 2024-04-09

Body

参数类型是否必选示例值描述
start_timeInteger1619827200查询起始时间(Unix时间戳)。
end_timeInteger1619913600查询结束时间(Unix时间戳)。
filtersObject of Condition-筛选条件,可以指定多个键值对来筛选数据。
page_noInteger1查询的页码。
page_sizeInteger20每页显示的数量。
metricsStringbattery_usage用于查询的电池指标名称。

order_by

String

avg_ascend

排序依据。

  • avg_ascend:按平均值升序排列
  • avg_descend:按平均值降序排列
  • pct25_ascend:按25分位值升序排列
  • pct25_descend:按25分位值降序排列
  • pct50_ascend:按50分位值升序排列
  • pct50_descend:按50分位值降序排列
  • pct75_ascend:按75分位值升序排列
  • pct75_descend:按75分位值降序排列
  • pct90_ascend:按90分位值升序排列
  • pct90_descend:按90分位值降序排列
  • pct99_ascend:按99分位值升序排列
  • pct99_descend:按99分位值降序排列
  • statistics_cnt_ascend:按统计量升序排列
  • statistics_cnt_descend:按统计量降序排列
sceneStringHomePage页面名称搜索词。

Condition

参数类型是否必选示例值描述

op

String

in

操作符。

  • gt:大于
  • gte:大于等于
  • lt:小于
  • lte:小于等于
  • eq:等于
  • neq:不等于
  • in:包含
  • not_in:不包含
  • lk:like
  • nlk:not like
  • regex:正则匹配
  • not_null:非正则匹配

type

String

expression

筛选条件类型。

  • expression:当前condition是一个表达式
  • and:当前condition是一个复合表达式,多个sub_condition的逻辑关系是and
  • or:当前condition是一个复合表达式,多个sub_condition的逻辑关系是or
  • map:当前condition是map类型
valueString123456筛选值。
valuesArray of String[123456]筛选值,支持多个。
map_keyStringkey_1map类型key,当type为map时必填。
dimensionStringaid条件的名称。
sub_conditionsArray of Condition-子条件。

返回参数

参数类型示例值描述
dataObject of SearchResponseData-返回内容
error_msgString-错误信息。
error_noInteger0错误码。

SearchResponseData

参数类型示例值描述
totalInteger10列表总数
resultArray of BatteryScenePageItem-列表详情。

BatteryScenePageItem

参数类型示例值描述
pct25Double10.525百分位值。
pct50Double14.050百分位值(中位数)。
pct75Double17.875百分位值。
pct90Double19.690百分位值。
pct99Double23.499百分位值。
sceneStringHomePage页面名称。
avg_valueDouble15.2平均指标值。
statistics_cntDouble200样本数量。

请求示例

POST https://open.volcengineapi.com?Action=GetAppBatteryPageList&Version=2024-04-09
{
    "start_time": 1619827200,
    "end_time": 1619913600,
    "filters": {
        "type": "and",
        "sub_conditions": [
            {
                "dimension": "apm_version",
                "type": "expression",
                "op": "in",
                "values": [
                    "1.4.5"
                ]
            },
            {
                "dimension": "device_model",
                "type": "expression",
                "op": "in",
                "values": [
                    "MI 5X"
                ]
            }
        ]
    },
    "page_no": 1,
    "page_size": 20,
    "metrics": "battery_usage",
    "order_by": "avg_ascend",
    "scene": "HomePage"
}

返回示例

{
    "data": {
        "total": 10,
        "result": [
            {
                "pct25": 10.5,
                "pct50": 14,
                "pct75": 17.8,
                "pct90": 19.6,
                "pct99": 23.4,
                "scene": "HomePage",
                "avg_value": 15.2,
                "statistics_cnt": 200
            }
        ]
    },
    "error_msg": "",
    "error_no": 0
}

错误码

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