You need to enable JavaScript to run this app.
导航
获取项目中心-访问统计-核心指标 - GetAccessCoreStatistics
最近更新时间:2024.12.06 13:07:28首次发布时间:2024.07.10 15:50:06

请求说明

  • 请求方式:POST
  • 接口名称:GetAccessCoreStatistics
  • 请求地址:https://console.volcengine.com/cdp/open_platform/openapi

请求参数

参数

类型

是否必选

示例值

描述

Authorization

String

HMAC-SHA256 Credential=BDPP2952f97532xxxxxx/20240716/cn/openPlatform/request, SignedHeaders=host;x-content-sha256;x-date, Signature=131f3d297eb22a7xxxxxx

详细介绍请查阅调用方式文档

X-Tenant

String

1

项目ID

Query

参数

类型

是否必选

示例值

描述

ApiAction

String

GetAccessCoreStatistics

固定值,对应“请求说明”中的“接口名称”

ApiVersion

String

2023-08-08

固定值,版本号: 2023-08-08

Body

参数

类型

是否必选

示例值

描述

startDate

String

业务开始时期 (yyyy-MM-dd)

endDate

String

业务结束时期 (yyyy-MM-dd)

modules

Array

选择模块

excludeUsers

Array[str]

剔除用户ID

period

String

day

统计周期(默认 day)
day,week,month

groupBy

String

查看方式

返回参数

参数

类型

示例值

描述

msg

String

成功

接口返回信息

code

Number

0

状态码,0表示正常

data

Array

[
        {
            "indexName": "totalUser",
            "value": 8
        },
        {
            "indexName": "newUser",
            "value": 2
        },
        {
            "indexName": "UV",
            "value": 3
        },
        {
            "indexName": "PV",
            "value": 5101
        },
        {
            "indexName": "avgPV",
            "value": 1700.3
        }
    ]

接口返回

请求示例

{
    "startDate": "2024-11-26",
    "endDate": "2024-12-03"
}

返回示例

{
    "code": 0,
    "msg": "成功",
    "data": [
        {
            "indexName": "totalUser",
            "value": 8
        },
        {
            "indexName": "newUser",
            "value": 2
        },
        {
            "indexName": "UV",
            "value": 3
        },
        {
            "indexName": "PV",
            "value": 5101
        },
        {
            "indexName": "avgPV",
            "value": 1700.3
        }
    ]
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

HTTP 状态码

错误码

错误信息

说明

400

invalidParameter

PARAMETER INVALID

参数非法,检查入参。