GetActionOverviewList--应用性能监控全链路版-火山引擎

文档中心

导航

GetActionOverviewList

最近更新时间：2024.07.12 17:21:37首次发布时间：2022.11.01 11:26:00

获取Action事件列表。

请求说明

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

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

请求参数

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`GetActionOverviewList`	接口名称。当前 API 的名称为 `GetActionOverviewList`。
Version	String	是	`2022-10-12`	接口版本。当前 API 的版本为 `2022-10-12`。

Body

参数	类型	是否必选	示例值	描述
common	Object of CommonParams	是	`-`	通用参数。
time_filter	Object of TimeFilter	是	`-`	时间区间。
pgno	Long	否	`1`	分页查询参数，用于设置当前页码。
pgsz	Long	否	`10`	分页查询参数，用于设置每页行数。
filter_conditions	Object of FilterCondition	否	`-`	筛选条件。
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耗时
metric_type	String	否	`avg`	耗时指标统计方式。 avg（默认） pct50 pct75 pct90 pct95

CommonParams

参数	类型	是否必选	示例值	描述
aid	Long	是	`12345`	应用ID。
site_type	String	是	`web`	站点类型。
env	String	是	`online`	环境，填""时为全部。
os	String	否	`webpro`	服务类型，可选值为webpro，app，minipro。
user	String	否	`test_user`	用户名。

TimeFilter

参数	类型	是否必选	示例值	描述
start_time	Integer	是	`1665485413`	起始时间，单位s。
end_time	Integer	是	`1665744613`	终止时间，单位s。
granularity	Integer	否	`3600`	聚合时间粒度，单位s。

FilterCondition

参数	类型	是否必选	示例值	描述
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不能同时存在。

返回参数

参数	类型	示例值	描述
errno	Integer	`0`	错误码。0为成功。
errmsg	String	`""`	错误信息。
data	Object of ActionListData	`-`	返回数据。

ActionListData

参数	类型	示例值	描述
data	Array of ActionListItem	`-`	返回数据。
total	Long	`10`	返回数据的数量。

ActionListItem

参数	类型	示例值	描述
pid	String	`数据探索`	页面ID。
metric_map	JSON Map	`-`	指标集合。
action_type	String	`click`	Action类型。
action_target_name	String	`描述`	Action名字。

MetricMap

参数	类型	示例值	描述
key	String	`action_count`	指标key。例如：duration，frontend_duration，http_count。
value	String	`30`	指标key的取值。

请求示例

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
}

错误码

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

应用性能监控全链路版

请求说明

Header

请求参数

Query

Body

CommonParams

TimeFilter

FilterCondition

返回参数

ActionListData

ActionListItem

MetricMap

请求示例

返回示例

错误码