获取自定义事件列表。
ServiceName: apmplus_openapi Region: cn-beijing X-App-Ids: xxx Content-Type: application/json
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | EventList | 接口名称。当前 API 的名称为 EventList。 |
| Version | String | 是 | 2022-10-12 | 接口版本。当前 API 的版本为 2022-10-12。 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| common | Object of CommonParams | 是 | - | 通用参数。 |
| time_filter | Object of TimeFilter | 是 | - | 时间区间。 |
| filter_conditions | Object of FilterCondition | 是 | - | 筛选条件。 |
| search_text | String | 否 | event_test | 事件名模糊搜索，填空返回全部事件。 |
| pgno | Integer | 是 | 10 | 事件列表页号。 |
| pgsz | Integer | 是 | 10 | 每页项数。 |
order_by | String | 否 |
| 排序维度。
|
order | String | 否 |
| 排序方式。
|
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| aid | Long | 是 | 12345 | 应用ID。 |
| site_type | String | 是 | web | 站点类型。 |
| env | String | 是 | online | 环境，填""时为全部。 |
| os | String | 否 | webpro | 服务类型，可选值为webpro，app，minipro。 |
| user | String | 否 | test_user | 用户名。 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| start_time | Integer | 是 | 1665485413 | 起始时间，单位s。 |
| end_time | Integer | 是 | 1665744613 | 终止时间，单位s。 |
| granularity | Integer | 否 | 3600 | 聚合时间粒度，单位s。 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| type | String | 是 | and | 筛选条件类型，可选值为and和rule，只支持两层，第一层的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 FilterCondition | 否 | - | 如果下层还有条件，则放入该处，即type为and时必填。这一层与field，op，groupkey以及values不能同时存在。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| error_no | Integer | 0 | 错误码，成功为0。 |
| error_msg | String | - | 错误信息，成功为空。 |
| data | Object of EventListData | - | 事件列表。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| total | Integer | 10 | 自定义事件总数。 |
| event_list | Array of EventListItem | - | 事件列表。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| event_name | String | event_test | 自定义事件名。 |
| user_total | Integer | 10 | 自定义事件上报用户数。 |
| user_trend | Object of ChartData | - | 自定义事件上报用户趋势。 |
| count_total | Integer | 10 | 自定义事件上报量。 |
| count_trend | Object of ChartData | - | 自定义事件上报趋势。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| fields | Array of Field | - | 折线图/饼图维度，len(fields)=len(source[i])。 |
| source | Array of String | [["1668355200","js_error","0","0"]] | 趋势图具体点的集合，len(source)为折线图点的数量或者饼图中块数量。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| id | String | date | 维度key。 |
| name | String | 日期 | 维度名。 |
| dataType | String | 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": "" }
本接口无特有的错误码。更多信息请参见错误码。