You need to enable JavaScript to run this app.
导航
AnalyseSummary
最近更新时间:2023.11.24 17:42:12首次发布时间:2022.10.14 11:52:07

调用AnalyseSummary接口查看事件概览。

使用说明

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

请求参数

Query

参数

类型

是否必选

示例值

描述

Action

String

AnalyseSummary

请求名称。

Version

String

2022-10-12

请求版本。

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

Body

参数

类型

是否必填

示例值

说明

os

string

iOS

操作系统。

  • iOS
  • Android

start_time

int32

1658664000

开始时间。

end_time

int32

1658750543

结束时间。

compare_start_time

int32

1658577457

比较开始时间。

compare_end_time

int32

1658664000

比较结束时间。

filters

object of filters

-

筛选条件。

order_by

string

count

排序条件。

event_name

string

null

事件名称。

attribute_type

string

metrics

属性类型。

  • metrics:指标
  • dimension:维度

attribute_name

string

test

属性名称。

filters

参数

类型

是否必填

示例值

说明

type

string

and

筛选条件操作类型。

sub_conditions

object of sub_conditions

-

子筛选条件。

sub_conditions

参数

类型

是否必填

示例值

说明

dimension

string

os

筛选维度。

op

string

in

子筛选条件操作。

  • in:包含

type

string

expression

子筛选条件操作类型。

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

values

array

[ "iOS" ]

筛选值。

返回参数

参数

类型

示例值

说明

err_detail

string

-

错误详情。

data

object of data

-

返回的业务数据。各个接口返回不同,部分接口无此字段。

error_msg

string

-

错误信息。

error_no

int

0

错误码。0为成功。

data

参数

类型

示例值

说明

count

object of count

-

事件上报量。

per_capita

object of per_capita

-

事件人均上报。

user

object of user

-

事件用户数。

count

参数

类型

示例值

说明

current

int32

870

当前上报量。

compare

int32

0

环比上报量。

rate

int32

0

上报量变化率。

per_capita

参数

类型

示例值

说明

current

int32

145

当前人均上报。

compare

int32

0

环比人均上报。

rate

int32

0

人均上报变化率。

user

参数

类型

示例值

说明

current

int32

6

当前用户数。

compare

int32

0

环比用户数。

rate

int32

0

用户数变化率。

请求示例

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

{
    "os":"iOS",
    "start_time":1658664000,
    "end_time":1658750543,
    "compare_start_time":1658577457,
    "compare_end_time":1658664000,
    "filters":{
        "type":"and",
        "sub_conditions":[
            {
                "dimension":"os",
                "op":"in",
                "type":"expression",
                "values":[
                    "iOS"
                ]
            }
        ]
    },
    "order_by":"count"
}

返回示例

{
    "err_detail": "",
    "data": {
        "count": {
            "current": 870,
            "compare": 0,
            "rate": 0
        },
        "per_capita": {
            "current": 145,
            "compare": 0,
            "rate": 0
        },
        "user": {
            "current": 6,
            "compare": 0,
            "rate": 0
        }
    },
    "error_msg": "",
    "error_no": 0
}