You need to enable JavaScript to run this app.
导航
EventList
最近更新时间:2023.12.26 18:54:55首次发布时间:2022.11.18 15:32:33

调用EventList接口获取自定义事件列表。

使用说明

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

请求参数

Query

参数

类型

是否必选

示例值

描述

Action

String

EventList

请求名称。

Version

String

2022-10-12

请求版本。

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

Body

参数

类型

是否必选

示例值

描述

common

object of common

-

通用参数。

time_filter

object of time_filter

-

时间区间。

filter_conditions

object of filter_conditions

-

筛选条件。

search_text

string

event_test

事件名模糊搜索,填空返回全部事件。

pgno

i32

10

事件列表页号。

pgsz

i32

10

每页项数。

order_by

string

count_trend

排序维度。

  • count_trend
  • user_trend

order

string

desc,asc

排序方式。

  • desc
  • asc

common

参数

类型

是否必选

示例值

描述

aid

i64

12345

应用ID。

site_type

string

web

站点类型。

env

string

online

环境,填""时为全部。

os

string

webpro

服务类型,可选值为webproappminipro

user

string

test_user

用户名。

time_filter

参数

类型

是否必选

示例值

描述

start_time

i32

1665485413

起始时间,单位s。

granularity

i32

3600

聚合时间粒度,单位s。

end_time

i32

1665744613

终止时间,单位s。

filter_conditions

参数

类型

是否必选

示例值

描述

type

string

and

筛选条件类型,可选值为andrule,只支持两层,第一层的type必须为and,第二层的type必须为rule。

field

string

pid

条件字段key,可选值集合由GetFieldKeys方法获取。

op

string

in

条件符号,可选值有eq,neq,lt,lte,gt,gte,in,not_in,regex,not_regex。

groupKey

string

context

map类型字段key,可选值集合由GetFieldKeys方法获取。

values

array of string

[数据探索]

条件值,可选值集合由GetFieldValues方法获取。

children

array of children

-

如果下层还有条件,则放入该处,这一层与field,op,groupkey以及values不能同时存在。

children

参数

类型

是否必选

示例值

描述

type

string

and

筛选条件类型,可选值为andrule,只支持两层,第一层的type必须为and,第二层的type必须为rule。

field

string

pid

条件字段key,可选值集合由GetFieldKeys方法获取。

op

string

in

条件符号,可选值有eq,neq,lt,lte,gt,gte,in,not_in,regex,not_regex。

groupKey

string

context

map类型字段key,可选值集合由GetFieldKeys方法获取。

values

array of string

[数据探索]

条件值,可选值集合由GetFieldValues方法获取。

children

array of string

-

如果下层还有条件,则放入该处,这一层与field,op,groupkey以及values不能同时存在。

返回参数

参数

类型

示例值

描述

error_no

i32

0

错误码,成功为0。

error_msg

string

-

错误信息,成功为空。

data

object of data

-

事件列表。

data

参数

类型

示例值

描述

total

i32

10

自定义事件总数。

event_list

array of event_list

-

事件列表。

event_list

参数

类型

示例值

描述

event_name

string

event_test

自定义事件名。

count_total

i32

10

自定义事件上报量。

user_total

i32

10

自定义事件上报用户数。

count_trend

object of count_trend

-

自定义事件上报趋势。

user_trend

object of user_trend

-

自定义事件上报用户趋势。

count_trend

参数

类型

示例值

描述

fields

array of fields

-

折线图/饼图维度,len(fields)=len(source[i])。

source

array of string

[["1668355200","js_error","0","0"]]

趋势图具体点的集合,len(source)为折线图点的数量或者饼图中块数量。

user_trend

参数

类型

示例值

描述

fields

array of fields

-

折线图/饼图维度,len(fields)=len(source[i])。

source

array of string

[["1668355200","js_error","0","0"]]

趋势图具体点的集合,len(source)为折线图点的数量或者饼图中块数量。

fields

参数

类型

示例值

描述

id

string

date

维度key。

dataType

string

string

维度类型。

name

string

日期

维度名。

aggregate

string

-

聚合方式。

请求示例

POST https://open.volcengineapi.com/?Action=EventList&Version=2022-10-12 
{
    "common": {
        "aid": 12345,
        "site_type": "web",
        "env": "online",
        "os": "webpro",
        "user": "test_user"
    },
    "time_filter": {
        "start_time": 1665485413,
        "end_time": 1665744613,
        "granularity": 3600
    },
    "filter_conditions": {
        "type": "and",
        "children": [
            {
                "type": "and",
                "field": "pid",
                "values": "[数据探索]",
                "op": "in",
                "children": [],
                "groupKey": "context"
            }
        ],
        "op": "in",
        "values": "[数据探索]",
        "field": "pid",
        "groupKey": "context"
    },
    "pgno": 10,
    "pgsz": 10,
    "order": "desc,asc",
    "order_by": "count_trend,user_trend",
    "search_text": "event_test"
}

返回示例

正常返回示例

{
    "data": {
        "event_list": [
            {
                "count_trend": {
                    "source": [
                        [
                            "1668355200",
                            "js_error",
                            "0",
                            "0"
                        ]
                    ],
                    "fields": [
                        {
                            "dataType": "string",
                            "aggregate": "",
                            "name": "日期",
                            "id": "date"
                        }
                    ]
                },
                "user_trend": {
                    "source": [
                        [
                            "1668355200",
                            "js_error",
                            "0",
                            "0"
                        ]
                    ],
                    "fields": [
                        {
                            "id": "date",
                            "aggregate": "",
                            "name": "日期",
                            "dataType": "string"
                        }
                    ]
                },
                "user_total": 10,
                "event_name": "event_test",
                "count_total": 10
            }
        ],
        "total": 10
    },
    "error_no": 0,
    "error_msg": ""
}

异常返回示例

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