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

GetAppFieldValues

最近更新时间2023.12.26 16:39:08

首次发布时间2023.03.13 16:59:23

调用GetAppFieldValues接口获取App筛选条件的可选取值。

使用说明

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

请求参数

Query

参数

类型

是否必选

示例值

描述

Action

string

GetAppFieldValues

请求名称。

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

1678586400

开始时间。

end_time

i32

1678674164

终止时间。

biz_type

string

crash

异常类型。

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

keyword

string

-

搜索关键字。

field

string

app_version

字段key。

  • os_version:系统版本
  • device_model:机型
  • app_version:App版本
  • update_version_code:App小版本
  • npth_version:APM SDK版本
  • channel:下载渠道
  • rom:ROM信息
  • province:省份
  • process_name:进程名
  • device_manufacturer:厂商
  • last_scene:App页面

limit

i32

100

返回多少数据,默认按上报量倒序排列.

filters

object of filters

-

筛选条件。

time_type

string

api_time

时间类型。

  • api_time:上报时间(默认)
  • event_time:发生时间

filters

参数

类型

是否必选

示例值

描述

type

string

and

筛选条件类型。

  • expression:表达式
  • map:映射
  • and:且条件
  • or:或条件

op

string

in

操作符。

  • in:包含

dimension

string

os

条件的名称。

values

array of string

["Android"]

筛选值,支持多个。

value

string

Android

筛选值。

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

aid

条件的名称。

values

array of string

[123456]

筛选值,支持多个。

value

string

123456

筛选值。

map_key

string

key_1

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

sub_conditions

array of string

-

子条件。

返回参数

参数

类型

示例值

描述

data

array of data

-

错误返回数据。

error_msg

string

-

错误信息。

error_no

i32

0

错误码。

data

参数

类型

示例值

描述

value

string

9.9.7

字段值。

label

string

9.9.7

字段值显示名称。

请求示例

POST https://open.volcengineapi.com/?Action=GetAppFieldValues&Version=2022-10-12 

{
    "aid":123456,
    "start_time":1678586400,
    "end_time":1678674164,
    "field":"app_version",
    "keyword":"",
    "limit":100,
    "filters":{
        "type":"and",
        "sub_conditions":[
            {
                "dimension":"os",
                "op":"in",
                "type":"expression",
                "values":[
                    "Android"
                ]
            }
        ]
    },
    "biz_type":"crash"
}

返回示例

正常返回示例

{
    "err_detail":"",
    "data":[
        {
            "value":"9.9.7",
            "label":"9.9.7"
        },
        {
            "value":"9.9.6",
            "label":"9.9.6"
        },
        {
            "value":"1.1.5",
            "label":"1.1.5"
        },
        {
            "value":"1.1.7",
            "label":"1.1.7"
        },
        {
            "value":"3.1.6-alpha.222",
            "label":"3.1.6-alpha.222"
        },
        {
            "value":"9.9.9",
            "label":"9.9.9"
        },
        {
            "value":"3.1.6-alpha.184",
            "label":"3.1.6-alpha.184"
        },
        {
            "value":"8.9.0",
            "label":"8.9.0"
        }
    ],
    "error_msg":"",
    "error_no":0
}

异常返回示例

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