You need to enable JavaScript to run this app.
导航
AnalyseEventList
最近更新时间:2025.01.23 17:50:40首次发布时间:2025.01.23 17:50:40

查看事件详情页列表。

请求说明

  • 请求方式:POST
  • 请求地址:https://open.volcengineapi.com?Action=AnalyseEventList&Version=2022-10-12

请求参数

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

Query

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

Body

参数类型是否必选示例值描述
osStringAndroid操作系统(Android, iOS)
start_timeInteger1630473600开始时间
end_timeInteger1630560000结束时间
filtersObject of Condition-筛选条件,可以指定多个键值对来筛选数据。
order_byStringcount排序方式(count, user, per_capita)
keywordStringexample_keyword关键词
event_nameStringevent事件名称(可选)
attribute_nameStringname属性名称(可选)
attribute_typeStringstring属性类型(可选)
page_noInteger1页码
page_sizeInteger20每页大小

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

返回参数

参数类型示例值描述
dataObject of EventListData事件列表
error_msgStringsuccess错误消息
error_noLong500错误码

EventListData

参数类型示例值描述
dataArray of EventItem事件列表
totalInteger10总数

EventItem

参数类型示例值描述
userLong10该事件下用户数
countLong10事件上报量
event_idLong10事件ID
event_nameStringevent事件名称
per_capitaDouble10人均上报 count/user
max_api_timeLong1630473600最近上报时间

请求示例

POST https://open.volcengineapi.com?Action=AnalyseEventList&Version=2022-10-12
{
    "os": "Android",
    "start_time": 1630473600,
    "end_time": 1630560000,
    "filters": {
        "op": "in",
        "type": "expression",
        "value": "Android",
        "values": [
            "Android"
        ],
        "map_key": "key_1",
        "dimension": "aid",
        "sub_conditions": [
            {
                "op": "in",
                "type": "expression",
                "value": "Android",
                "values": [
                    "Android"
                ],
                "map_key": "key_1",
                "dimension": "aid",
                "sub_conditions": []
            }
        ]
    },
    "order_by": "count",
    "keyword": "example_keyword",
    "event_name": "event",
    "attribute_name": "name",
    "attribute_type": "string",
    "page_no": 1,
    "page_size": 20
}

返回示例

{
    "data": {
        "data": [
            {
                "user": 10,
                "count": 10,
                "event_id": 10,
                "event_name": "event",
                "per_capita": 10,
                "max_api_time": 1630473600
            }
        ],
        "total": 10
    },
    "error_msg": "success",
    "error_no": 500
}

错误码

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