You need to enable JavaScript to run this app.
导航
UrlList
最近更新时间:2024.07.12 17:21:39首次发布时间:2022.11.18 15:32:35

获取页面列表。

请求说明

  • 请求方式:POST
  • 请求地址:https://open.volcengineapi.com/?Action=UrlList&Version=2022-10-12
ServiceName: apmplus_openapi
Region: cn-beijing 
X-App-Ids: xxx
Content-Type: application/json

请求参数

Query

参数类型是否必选示例值描述
ActionStringUrlList接口名称。当前 API 的名称为 UrlList
VersionString2022-10-12接口版本。当前 API 的版本为 2022-10-12

Body

参数类型是否必选示例值描述
commonObject of CommonParams-通用参数。
time_filterObject of TimeFilter-时间区间。
filter_conditionsObject of FilterCondition-筛选条件。
page_numInteger1页号。
page_sizeInteger10每页项数。

order

String

asc,desc

排序方式。

  • asc:升序
  • desc:倒序
order_by_metricStringjs_error.count排序依据,由OverviewMetrics方法获取。
search_textStringpid_pid模糊搜索,不传则默认全部。
metric_listArray of MetricList-页面指标列表,由OverviewMetrics方法获取。
top_pidsArray of String[pid_1,pid_2]置顶pid列表。

CommonParams

参数类型是否必选示例值描述
aidLong12345应用ID。
site_typeStringweb站点类型。
envStringonline环境,填""时为全部。
osStringwebpro服务类型,可选值为webproappminipro
userStringtest_user用户名。

TimeFilter

参数类型是否必选示例值描述
start_timeInteger1665485413起始时间,单位s。
end_timeInteger1665744613终止时间,单位s。
granularityInteger3600聚合时间粒度,单位s。

FilterCondition

参数类型是否必选示例值描述
typeStringand筛选条件类型,可选值为andrule,只支持两层,第一层的type必须为and,第二层的type必须为rule。
fieldStringpid条件字段key,可选值集合由GetFieldKeys方法获取。
opStringin条件符号,可选值有eq,neq,lt,lte,gt,gte,in,not_in,regex,not_regex。
groupKeyStringcontextmap类型字段key,可选值集合由GetFieldKeys方法获取。
valuesArray of String[数据探索]条件值,可选值集合由GetFieldValues方法获取。
childrenArray of FilterCondition-如果下层还有条件,则放入该处,即type为and时必填。这一层与field,op,groupkey以及values不能同时存在。

MetricList

参数类型是否必选示例值描述
nameStringjs_error.count指标key。
typeStringnumber指标值类型,是数值指标还是率值指标。
unitStringms指标值单位。
groupKeyStringjs_error组别key。
groupNameStringJS错误组名。
isDefaultBooleantrue是否默认展示。
descriptionStringPV指标名。

返回参数

参数类型示例值描述
dataObject of ListData-页面指标总览值列表。
error_msgString-错误信息,成功为空。
error_noInteger0错误码,成功为0。

ListData

参数类型示例值描述
countInteger20页面总数。
table_listArray of ListItem-各页面指标总览值。
summary_metricJSON Map-所有页面指标总览值。

ListItem

参数类型示例值描述
nameString/path_test页面ID。
onTopBooleantrue默认为false,如果为用户所选置顶页面为true。
metric_mapJSON Map-指标总览值。

SummaryMetric

参数类型示例值描述
keyString-页面指标key。
valueObject of MetricDetail

MetricMap

参数类型示例值描述
keyString-指标对应的key。
valueObject of MetricDetail

MetricDetail

参数类型示例值描述
typeString-指标类型。
valueDouble1000指标值。
changeDouble0.01指标环比。

positive

Boolean

true

是否优化。

  • true:优化
  • false:劣化

请求示例

POST https://open.volcengineapi.com/?Action=UrlList&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",
        "children": [
            {
                "type": "and",
                "op": "in",
                "children": [],
                "groupKey": "context",
                "field": "pid",
                "values": "[数据探索]"
            }
        ],
        "op": "in",
        "field": "pid",
        "groupKey": "context",
        "values": "[数据探索]"
    },
    "search_text": "pid_",
    "order_by_metric": "js_error.count",
    "top_pids": "[pid_1,pid_2]",
    "page_size": 10,
    "page_num": 1,
    "metric_list": [
        {
            "isDefault": true,
            "unit": "ms",
            "groupName": "JS错误",
            "groupKey": "js_error",
            "description": "PV",
            "type": "number",
            "name": "js_error.count"
        }
    ],
    "order": "asc,desc"
}

返回示例

{
    "data": {
        "table_list": [
            {
                "link": "",
                "name": "/path_test",
                "onTop": true
            }
        ],
        "count": 20
    },
    "error_msg": "",
    "error_no": 0
}

错误码

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