You need to enable JavaScript to run this app.
导航
应用性能监控全链路版
  • 文档首页
    • /
  • 应用性能监控全链路版

UrlOverview

最近更新时间：2023.12.26 18:54:59

首次发布时间：2022.11.18 15:32:35

我的收藏

调用UrlOverview接口获取所有页面总览值。

使用说明

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

请求参数

Query

参数

类型

是否必选

示例值

描述

Action

String

是

UrlOverview

请求名称。

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

否

-

筛选条件。

common

参数

类型

是否必选

示例值

描述

aid

i64

是

12345

应用ID。

site_type

string

是

web

站点类型。

env

string

是

online

环境，填""时为全部。

os

string

否

webpro

服务类型，可选值为webpro，app，minipro。

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

筛选条件类型，可选值为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 children

否

-

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

children

参数

类型

是否必选

示例值

描述

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 string

否

-

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

返回参数

参数

类型

示例值

描述

data

object of data

-

页面指标总览值。

error_msg

string

-

错误信息，成功为空。

error_no

i32

0

错误码，成功为0。

data

参数

类型

示例值

描述

count

i32

20

pid总数。

overview_list

array of overview_list

-

指标总览值。

overview_list

参数

类型

示例值

描述

description

string

JS错误数最高

指标描述。

ev_type

string

js_error

指标类型。

link

string

/test

页面ID。

detail

object of detail

-

指标详情。

detail

参数

类型

示例值

描述

good_metric

boolean

true

正向指标还是负向指标。

metric_value

i32

1000

指标值。

unit

string

ms

指标值单位。

请求示例

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

返回示例

正常返回示例

{
    "data": {
        "count": 20,
        "overview_list": [
            {
                "description": "JS错误数最高",
                "detail": {
                    "good_metric": true,
                    "metric_value": 1000,
                    "unit": "ms",
                    "metric_name": ""
                },
                "ev_type": "js_error",
                "link": "/test"
            }
        ]
    },
    "error_no": 0,
    "error_msg": ""
}

异常返回示例

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