Documentation API Docs Visitor Report ReportVisitorCustomTopDailyService

ReportVisitorCustomTopDailyService

Update time: 2026-10-09 10:39:19

Applicable Products

Content Acceleration,Dynamic Web Acceleration

API Description

ReportVisitorCustomTopDailyService

Call frequency

Single user trigger frequency: 300/5min

Request parameter(s)

Body Params

NameDescription
dateFromString
Start Time. 1. The time format is yyyy-MM-ddTHH:mm:ss±HH:mm. Please note: ±HH:mm is the time zone offset and can be adjusted according to your data requirements. For example, +00:00 represents UTC, +08:00 represents UTC+08:00, and -05:00 represents UTC-05:00. 2026-08-27T10:30:45+00:00 represents 10:30:45 AM UTC on August 27, 2026. 2. It cannot be later than the current time. 3. Data from the most recent 3 months (90 days) can be retrieved at most.
dateToString
End time。1. The time format is yyyy-MM-ddTHH:mm:ss±HH:mm。Please note: ±HH:mm is the time zone offset and can be adjusted according to your data requirements。For example, +00:00 represents UTC time, +08:00 represents China Standard Time, and -05:00 represents Eastern Standard Time。2026-08-28T10:30:45+00:00 represents 10:30:45 AM UTC on August 28, 2026。2. The end time must be later than the start time。If the end time is later than the current time, the current time is used。3. If neither dateFrom nor dateTo is provided, the past 7 days are queried by default;if only one of them is not provided, an exception is thrown。4. The maximum allowable query interval is 31 days;that is, the difference between dateFrom and dateTo cannot exceed 31 days (please contact Technical Support for adjustments)。
domainList
Domain name: 1. The upper limit of the number of domain names that can be passed is 100 by default (you can contact technical support to adjust it); 2. Automatically filter out illegal domain names (if an illegal domain name is passed, it will be filtered out, and the query result will only return data for legal domain names); 3. When this parameter is not passed, all domain names under the account will be queried by default, but an error will be prompted when the number of domain names under the account exceeds the upper limit.
topString
Number of TOPs: 1. If not specified, the default is TOP 10; 2. The maximum number of TOPs is 100.
orderByString
Sorting: 1. Optional values: request, flow 2. Do not pass the default request

Response parameter(s)

Body Params

NameDescription
codeString
request result status code
messageString
Request result information
dataList
Detailed data on the results of the request
topString
Top
ipString
IP
totalFlowString
Total traffic: The unit of measurement is MB, with 2 decimal places.
totalRequestString
Total requests

Error code

Error code(code)Description(message)HTTP statusSemantic
24102013The accept header specified in your request is not acceptable.400The accept header specified in your request is not acceptable.
24102020The value of X-Time-Zone header specified in your request in invalid.400The value of X-Time-Zone header specified in your request in invalid.
24102002There was an error in the body of your HTTP request.400There was an error in the body of your HTTP request.
24102006The date specified is invalid.400The date specified is invalid.
24102007You cannot specify a period greater than xx minute(s).400You cannot specify a period greater than xx minute(s).
24102019The request was rejected because the number of domain(xx) exceeds the limit (xx).400The request was rejected because the number of domain(xx) exceeds the limit (xx).
24102008param: domain is null or invalid.400param: domain is null or invalid.
24102008param: orderBy is null or invalid.400param: orderBy is null or invalid.
24102008param: top is null or invalid.400param: top is null or invalid.
24102500We encountered an internal error. Please try again.500We encountered an internal error. Please try again.

Example

JSON
TIMEZONEJSON
JSON
Request example
Copy Copy success
#!/bin/bash
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.atomile.com/api/report/visitor/custom-top/daily" \
-X "POST" \
-u "$username:$password" \
-H "Date: $date" \
-d '{
  "dateFrom": "2021-10-18",
  "dateTo": "2021-10-22",
  "domain": [
    "www.aaaa.com"
  ],
  "orderBy":"flow",
  "top":100
}'
Response example
Copy Copy success
{
  "code" : "0",
  "message" : "success",
  "data" : [ {
    "top" : "1",
    "ip" : "1.1.1.2",
    "totalRequest" : "10000",
    "totalFlow" : "1000.00"
  }, {
    "top" : "2",
    "ip" : "1.1.1.4",
    "totalRequest" : "3000",
    "totalFlow" : "500.00"
  }, {
    "top" : "3",
    "ip" : "1.1.1.1",
    "totalRequest" : "1000",
    "totalFlow" : "100.00"
  }, {
    "top" : "4",
    "ip" : "1.1.1.3",
    "totalRequest" : "900",
    "totalFlow" : "800.00"
  } ]
}