You need to enable JavaScript to run this app.
导航

GetAppConsumerBatteryFieldValues

最近更新时间2024.04.25 19:58:20

首次发布时间2024.04.25 17:57:50

获取电量筛选条件的可选取值。

请求说明

  • 请求方式:POST
  • 请求地址:?Action=GetAppBatteryFieldValues&Version=2024-04-09

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

请求参数

Query

参数

类型

是否必选

示例值

描述

Action

String

GetAppBatteryFieldValues

接口名称。当前 API 的名称为 GetAppBatteryFieldValues

Version

String

2024-04-09

接口版本。当前 API 的版本为 2024-04-09

Body

参数

类型

是否必选

示例值

描述

start_time

Integer

1617225600

查询开始时间(Unix时间戳)。

end_time

Integer

1617312000

查询结束时间(Unix时间戳)。

field

String

region

需要聚合或筛选的字段名。

limit

Integer

10

返回记录的数量限制。

filters

Object of Condition

-

筛选条件,可以指定多个键值对来筛选数据。

metrics

String

req_cnt_v2

可选的指标名。

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类型

value

String

123456

筛选值。

values

Array of String

[123456]

筛选值,支持多个。

map_key

String

key_1

map类型key,当type为map时必填。

dimension

String

aid

条件的名称。

sub_conditions

Array of Condition

-

子条件。

返回参数

参数

类型

示例值

描述

data

Array of RangeItem

-

返回内容。

error_msg

String

-

错误信息。

error_no

Integer

0

错误码。

RangeItem

参数

类型

示例值

描述

label

String

Label 123

筛选条件的标签。

value

String

value123

筛选条件的可选取值。

请求示例

POST ?Action=GetAppBatteryFieldValues&Version=2024-04-09
{
    "start_time": 1617225600,
    "end_time": 1617312000,
    "field": "region",
    "limit": 10,
    "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"
                ]
            }
        ]
    },
    "metrics": "req_cnt_v2"
}

返回示例

{
    "data": [
        {
            "label": "Label 123",
            "value": "value123"
        }
    ],
    "error_msg": "",
    "error_no": 0
}