You need to enable JavaScript to run this app.
导航
UrlOverviewMetrics
最近更新时间:2023.12.26 18:54:59首次发布时间:2022.11.18 15:32:35

调用UrlOverviewMetrics接口获取页面相关指标。

使用说明

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

请求参数

Query

参数

类型

是否必选

示例值

描述

Action

String

UrlOverviewMetrics

请求名称。

Version

String

2022-10-12

请求版本。

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

Body

参数

类型

是否必选

示例值

描述

common

object of common

-

通用参数。

common

参数

类型

是否必选

示例值

描述

aid

i64

12345

应用ID。

site_type

string

web

站点类型。

env

string

online

环境,填""时为全部。

os

string

webpro

服务类型,可选值为webproappminipro

user

string

test_user

用户名。

返回参数

参数

类型

示例值

描述

data

array of data

-

页面指标。

error_msg

string

-

错误信息,成功为空。

error_no

i32

0

错误码,成功为0。

data

参数

类型

示例值

描述

description

string

PV

指标名。

groupKey

string

js_error

组别key。

groupName

string

JS错误

组名。

name

string

js_error.count

指标key。

isDefault

boolean

true

是否默认展示。

type

string

number

指标值类型。

  • number:数值指标。
  • rate:率值指标。

unit

string

ms

指标值单位。

请求示例

POST https://open.volcengineapi.com/?Action=UrlOverviewMetrics&Version=2022-10-12 
{
    "common": {
        "aid": 12345,
        "site_type": "web",
        "env": "online",
        "os": "webpro",
        "user": "test_user"
    }
}

返回示例

正常返回示例

{
    "error_msg": "",
    "data": [
        {
            "type": "number",
            "groupKey": "js_error",
            "isDefault": true,
            "groupName": "JS错误",
            "unit": "ms",
            "name": "js_error.count",
            "description": "PV"
        }
    ],
    "error_no": 0
}

异常返回示例

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