You need to enable JavaScript to run this app.
导航
GetActionOverviewList
最近更新时间:2023.04.11 16:11:01首次发布时间:2022.11.01 11:26:00

调用GetActionOverviewList接口获取Action事件列表。

使用说明

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

请求参数

Query

参数

类型

是否必选

示例值

描述

Action

String

GetActionOverviewList

请求名称。

Version

String

2022-10-12

请求版本。

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

Body

参数

类型

是否必填

示例值

说明

time_filter

object of time_filter

-

时间区间。

common

object of common

-

通用参数。

order_by

string

longtask_count

排序依据。

  • action_duration:操作耗时
  • frontend_duration:前端耗时
  • request_duration:请求耗时
  • count:Action触发数
  • http_count:平均触发请求数
  • js_err_count:JS错误总数
  • longtask_count:longtask数
  • longtask_duration:longtask耗时

pgsz

int32

20

每页大小。默认为1。

pgno

int32

1

页数。默认为1。

metric_type

string

avg

耗时指标统计方式。

  • avg(默认)
  • pct50
  • pct75
  • pct90
  • pct95

filter_conditions

object of filter_conditions

-

筛选条件。

time_filter

参数

类型

是否必填

示例值

说明

start_time

int32

1666003194

起始时间。

end_time

int32

1666004994

终止时间。

granularity

int32

60

聚合时间粒度。

common

参数

类型

是否必填

示例值

说明

aid

int64

12345

应用ID。

filter_conditions

参数

类型

是否必填

示例值

说明

type

string

and

筛选条件类型。

  • and:children中的条件为与关系。
  • rule(默认):当前条件为原子条件。

children

array of children

-

type值为and时必填。

children

参数

类型

是否必填

示例值

说明

op

string

in

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

field

string

pid

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

values

[]string

["数据探索"]

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

返回参数

参数

类型

示例值

说明

err_detail

string

-

错误详情。

data

object of data

-

返回内容。

error_msg

string

-

错误信息。

error_no

int

0

错误码。0为成功。

data

参数

类型

示例值

说明

action_type

string

click

Action类型。

pid

string

数据探索

页面ID。

action_target_name

int32

描述

Action名字。

metric_map

object of metric_map

-

指标集合。

metric_map

参数

类型

示例值

说明

action_count

string

14

Action发生次数。

duration

string

1984.54

Action耗时统计值。

frontend_duration

string

1220.10

Action前端耗时统计值。

http_count

string

9

Action发生的请求数。

http_duration

string

1070.22

Action发生的http耗时统计值。

js_err_count

string

0

Action的JS错误数统计值。

longtask_count

string

40

Action下的longtask数量统计值。

longtask_duration

string

457.78

Action下的longtask耗时统计值。

max_js_err_count

string

0

该Action下发生的最大JS错误数。

请求示例

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

{
    "time_filter":{
        "start_time":1665485413,
        "end_time":1665744613
    },
    "common":{
        "aid":12345
    },
    "pgsz":20,
    "pgno":1,
    "metric_type":"avg",
    "order_by":"frontend_duration",
    "filter_conditions":{
        "type":"and",
        "children":[
            {
                "op":"in",
                "field":"pid",
                "values":[
                    "数据探索"
                ]
            }
        ]
    }
}

返回示例

{
    "err_detail":"",
    "data":{
        "data":[
            {
                "action_type":"click",
                "pid":"数据探索",
                "action_target_name":"描述",
                "metric_map":{
                    "action_count":"14",
                    "duration":"1984.54",
                    "frontend_duration":"1220.10",
                    "http_count":"9",
                    "http_duration":"1070.22",
                    "js_err_count":"0",
                    "longtask_count":"40",
                    "longtask_duration":"457.78",
                    "max_js_err_count":"0"
                }
            }
        ]
    },
    "error_msg":"",
    "error_no":0
}