You need to enable JavaScript to run this app.
导航
获取独立访客的细分数据
最近更新时间:2024.06.13 20:08:15首次发布时间:2024.04.16 14:36:31

API 说明

基于火山引擎内容分发网络(CDN)收到的用户请求,该 API 对独立客户端 IP 地址数量统计各时间点的指标细分数据。

要调用该 API,您需要指定一个加速域名、一个统计时间段和一个时间粒度。您还可以指定多个过滤条件对用户请求进行过滤。您最多能查询过去 92 天的数据。

数据稳定性:受网络波动影响,边缘节点上统计的指标数据可能会发生变化。大多数情况下,指标数据会在 12 小时内逐步稳定下来。

说明

如果您是刚开始使用数据统计的 API,请务必先阅读以下文档,这将有助于您理解该 API 文档。

使用限制

节流限制:您每秒最多可以提交 20 个 API 请求。

请求说明

  • 请求方式:POST
  • 请求地址:https://cdn.volcengineapi.com/?Action=DescribeUserData&Version=2021-03-01

请求参数

Query

参数名称
数据类型
是否必选
参数说明
Action
String
接口名称。当前 API 的名称为 DescribeUserData
Version
String
接口版本。当前 API 的版本为 2021-03-01

Body

参数名称
数据类型
是否必选
参数说明
示例
StartTime
Long
表示统计时间段的开始时间,格式是 Unix 时间戳,精度是秒。StartTime 必须早于或者等于 EndTime。同时,StartTime 与 EndTime 所表示的统计时间段不能超过 31 天。
1710259200
EndTime
Long
表示统计时间段的结束时间,格式是 Unix 时间戳,精度是秒。
1710836303
Interval
String

表示一个时间粒度。该 API 基于 IntervalStartTimeEndTime 所表示的统计时间段拆分成一系列的时间区间,然后对每个时间区间统计独立客户端 IP 地址的数量。

关于 Interva参数是如何用来拆分统计时间段,参考 统计时间段说明

该参数有以下取值:

  • hour:表示时间粒度是 1 小时。
  • day:表示时间粒度是 1 天。
hour
Domain
String

表示一个加速域名,用于对用户请求进行过滤。

说明

当子账号调用该 API 时,请留意以下说明:

  • 子账号可以指定的加速域名是该子账号有权限访问的那些加速域名。子账号可以调用 ListCdnDomains 获取其有权限访问的加速域名。
www.example.com
IpVersion
String

表示请求使用的一个网络层协议,用于对用户请求进行过滤。该参数的可用值如下:

  • IPv4:表示 IPv4 协议。
  • IPv6:表示 IPv6 协议。
如果不指定 IpVersion,表示不使用该参数对请求进行过滤。
IPv4
Location
String

表示一个国家或地区的代码,用于对用户请求进行过滤。 CDN 对来自这些国家和地区的用户请求统计客户端 IP 地址的数量。

  • 如果您指定了 Location,就不能指定 Province,反之亦然。
  • 如果您不指定 Location,表示不使用该参数对请求进行过滤。
您可以调用 DescribeCdnRegionAndIsp 获取代码与国家和地区的对应表。
AZE
Province
String

表示一个中国省级行政区的代码,用于对用户请求进行过滤。 CDN 对来自这些省级行政区的用户请求统计客户端 IP 地址的数量。

如果您不指定 Province,表示不使用该参数对请求进行过滤。

您可以调用 DescribeCdnRegionAndIsp 获取代码与中国省级行政区的对应表。
AH

返回参数

参数名称
数据类型
参数说明
示例
MetricDataList
Object[]
表示一组数据对象,包含每个时间点的独立客户端 IP 地址数量。

请求示例

POST https://cdn.volcengineapi.com/?Action=DescribeUserData&Version=2021-03-01
{
    "Domain": "www.example.com",
    "StartTime": 1710950400,
    "EndTime": 1710998170,
    "Interval": "hour",
    "IpVersion": "IPv4",
    "Province": "AH"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202403220141458C564C77FA147001D2E1",
        "Action": "DescribeUserData",
        "Version": "2021-03-01",
        "Service": "CDN",
        "Region": "cn-north-01"
    },
    "Result": {
        "MetricDataList": [
            {
                "TimeStamp": 1710950400,
                "Value": 421
            },
            {
                "TimeStamp": 1710954000,
                "Value": 428
            },
            {
                "TimeStamp": 1710957600,
                "Value": 439
            },
            {
                "TimeStamp": 1710961200,
                "Value": 436
            },
            {
                "TimeStamp": 1710964800,
                "Value": 435
            },
            {
                "TimeStamp": 1710968400,
                "Value": 446
            },
            {
                "TimeStamp": 1710972000,
                "Value": 433
            },
            {
                "TimeStamp": 1710975600,
                "Value": 430
            },
            {
                "TimeStamp": 1710979200,
                "Value": 428
            },
            {
                "TimeStamp": 1710982800,
                "Value": 412
            },
            {
                "TimeStamp": 1710986400,
                "Value": 423
            },
            {
                "TimeStamp": 1710990000,
                "Value": 417
            },
            {
                "TimeStamp": 1710993600,
                "Value": 394
            },
            {
                "TimeStamp": 1710997200,
                "Value": 407
            }
        ]
    }
}