该接口用于查询多个域名的独立访客数(UV)。用户可以通过指定多个域名以及查询的时间范围来获取结果,查询数据粒度可选1小时/1天,结果数据包括每个域名的UV总数、UV峰值及每个时间片对应的UV。该接口适用于需要监控或分析网站受访情况的场景。
| 参数名称 | 描述 |
|---|---|
dateFromString | 开始时间:
1.时间格式为 yyyy-MM-ddTHH:mm:ss±HH:mm。请注意:±HH:mm 为时区偏移量,可根据您的数据需要进行调整,例如 +00:00 代表 UTC 时间,+08:00 代表东八区,-05:00 代表西五区。2024-01-15T10:30:45+00:00,表示UTC 时间 2024 年 1 月 15 日上午 10 点 30 分 45 秒;
2.不能大于当前时间
3.最多可获取最近半年(183天)的数据。 |
dateToString | 结束时间:
1.时间格式为 yyyy-MM-ddTHH:mm:ss±HH:mm。请注意:±HH:mm 为时区偏移量,可根据您的数据需要进行调整,例如 +00:00 代表 UTC 时间,+08:00 代表东八区,-05:00 代表西五区。2024-01-15T10:30:45+00:00,表示UTC 时间 2024 年 1 月 15 日上午 10 点 30 分 45 秒
2.结束时间需大于开始时间,结束时间如果大于当前时间,取当前时间。
3.dateFrom,dateTo二者都未传,默认查询过去的24小时;如仅有一个未传,抛异常
4.允许查询最大时间间隔:31天,即dateFrom和dateTo相差不能超过31天。(可联系技术支持调整) |
dataIntervalString | 数据粒度
1.支持1h(1小时粒度)、1d(1天粒度);
2.不传默认为1h; |
domainList | 域名:
1.可传递域名数量上限默认为20个(可联系技术支持调整);
2.自动过滤掉无效域名(如传递非法域名,会被过滤,查询结果只返回有效域名的数据)。
3.不传默认查全部域名 |
| 参数名称 | 描述 |
|---|---|
resultList | 结果 |
domainString | 域名 |
peakTimeString | 峰值时间 |
peakUVString | UV峰值 |
totalUVString | UV总数 |
uvDataList | UV数 |
timestampString | 时间
1.查询的数据粒度为1h时,格式为yyyy-MM-dd HH;每一个时间片数据值代表的是前一个时间粒度范围内的数据值。一天开始的时间片是yyyy-MM-dd 01,最后一个时间片是(yyyy-MM-dd+1) 00;
2.查询的数据粒度为1d时,格式为yyyy-MM-dd;每一个时间片数据值代表的该天内的数据值。
3.返回开始时间和结束时间包含的时间片。 |
valueString | UV数 |
| 错误代码(code) | 描述(message) | HTTP状态码 | 语义 |
|---|---|---|---|
| NotAcceptable | The accept header specified in your request is not acceptable. | 400 | Accept请求头不支持,接口仅支持json和xml格式,默认为json格式 |
| InvalidHTTPRequest | There was an error in the body of your HTTP request. | 400 | 请求体格式错误 |
| InternalError | We encountered an internal error. Please try again. | 500 | 系统发生错误 |
| TimeZoneInvalid | The value of X-Time-Zone header specified in your request in invalid. | 400 | 请求头X-Time-Zone不符合规则 |
| InvalidDatePeriod | The date specified is invalid. | 400 | 日期不符合 |
| PARAM_INVALID | param: domain is null or invalid | 400 | domain值为空 |
| PARAM_INVALID | param: dataInterval is null or invalid | 400 | dataInterval 错误 |
| NumberLimitExceeded | The request was rejected because the number of domain(6) exceeds the limit (5). | 400 | 输入的domain超过数据字典配置个数 |
#!/bin/bash
# Please remember to change the param (-H "X-Time-Zone") in this demo to the TimeZone you want in response
username='example_username'
apiKey='example_apiKey'
date=`env LANG="en_US.UTF-8" date -u "+%a, %d %b %Y %H:%M:%S GMT"`
password=`echo -en "$date" | openssl dgst -sha1 -hmac $apiKey -binary | openssl enc -base64`
curl -i --url "https://api.cdnetworks.com/api/report/uv" \
-X "POST" \
-H "X-Time-Zone:GMT+00:00" \
-u "$username:$password" \
-H "Date: $date" \
-H "Accept: application/json" \
-d '{"dateFrom": "2022-04-13T10:00:00+00:00","dateTo": "2022-04-14T23:00:00+00:00","dataInterval":"1h","domain": ["www.aaa.com","www.bbb.com"]
}'{
"result": [
{
"domain": "www.aaa.com",
"peakTime": "2022-04-13 22",
"peakUV": "13508",
"totalUV": "163592",
"uvData": [
{
"timestamp": "2022-04-13 10",
"value": "11660"
},
{
"timestamp": "2022-04-13 11",
"value": "11814"
},
{
"timestamp": "2022-04-13 12",
"value": "11968"
},
{
"timestamp": "2022-04-13 13",
"value": "12122"
},
{
"timestamp": "2022-04-13 14",
"value": "12276"
},
{
"timestamp": "2022-04-13 15",
"value": "12430"
},
{
"timestamp": "2022-04-13 16",
"value": "12584"
},
{
"timestamp": "2022-04-13 17",
"value": "12738"
},
{
"timestamp": "2022-04-13 18",
"value": "12892"
},
{
"timestamp": "2022-04-13 19",
"value": "13046"
},
{
"timestamp": "2022-04-13 20",
"value": "13200"
},
{
"timestamp": "2022-04-13 21",
"value": "13354"
},
{
"timestamp": "2022-04-13 22",
"value": "13508"
},
{
"timestamp": "2022-04-13 23",
"value": "0"
},
{
"timestamp": "2022-04-14 00",
"value": "0"
},
{
"timestamp": "2022-04-14 01",
"value": "0"
},
{
"timestamp": "2022-04-14 02",
"value": "0"
},
{
"timestamp": "2022-04-14 03",
"value": "0"
},
{
"timestamp": "2022-04-14 04",
"value": "0"
},
{
"timestamp": "2022-04-14 05",
"value": "0"
},
{
"timestamp": "2022-04-14 06",
"value": "0"
},
{
"timestamp": "2022-04-14 07",
"value": "0"
},
{
"timestamp": "2022-04-14 08",
"value": "0"
},
{
"timestamp": "2022-04-14 09",
"value": "0"
},
{
"timestamp": "2022-04-14 10",
"value": "0"
}
]
}
]
}