QuerySumUpTrafficUnderAccount
Update time: 2026-07-13 15:49:13
Applicable Products
universal
API Description
Query Traffic summary for all domains under a user account. Users specify start and end times to obtain detailed Traffic data, with granularity options of 5 minutes, 1 hour, or 1 day. This helps users analyze CDN Traffic usage for each domain within the specified period.
- API URL: https://api.atomile.com/api/report/flow
- Method: GET
- Limit Description: The request header X-Time-Zone should be included when a specific timezone is required for the returned data. For example, to display returned data in zero time zone , include the header X-Time-Zone: GMT+00:00 in your request.
- Data latency: 5~15min
Call frequency
Single user trigger frequency: 300/5min
Request parameter(s)
Body Params
| Name | Description |
|---|---|
*datefromString | Start time
1.The time format is yyyy-MM-ddTHH:mm:ss±HH:mm. Please note: ±HH:mm is the time zone offset, which can be adjusted according to your data needs, for example, +00:00 represents UTC time, +08:00 represents East 8th District, and -05:00 represents West 5th District. 2024-01-15T10:30:45+00:00 means UTC time January 15, 2024 10:30:45 AM;
2.Must be smaller than the current time and 'dateto';
3.Period between 'datafrom' and 'dateto' cannot be longer than 31 days |
*datetoString | End time
1.The time format is yyyy-MM-ddTHH:mm:ss±HH:mm. Please note: ±HH:mm is the time zone offset, which can be adjusted according to your data needs, for example, +00:00 represents UTC time, +08:00 represents East 8th District, and -05:00 represents West 5th District. 2024-01-15T10:30:45+00:00 means UTC time January 15, 2024 10:30:45 AM;
2.Must be greater than 'datefrom';
3.if it's greater than the current time, then the current time is assigned as the value |
*typeString | Data granularity
1.fiveminutes: five minutes, hourly: one hour, daily: one day;
2.If not specified, daily is set as the default value;
3.If fiveminutes is specified as the value, then data is returned in actual configured granularity when there is a specific configuration on data collecting granularity for the custome |
Response parameter(s)
Body Params
| Name | Description |
|---|---|
flowSummaryString | Total traffic. Keep two digits of decimals. Unit: MB |
flowDataList | flowData |
timestampString | Date
1.When the data query granularity is fiveminutes, the format is yyyy-MM-dd HH:mm; the data value of every time slice represents the data value within the previous time granularity range. The first time slice of the day is yyyy-MM-dd 00:05 AM, and the last one is yyyy-MM-dd 24:00.
2.When the data query granularity is hourly, the format is yyyy-MM-dd HH; the data value of every time slice represents the data value within the previous time granularity range. The first time slice of the day is yyyy-MM-dd 00:01, and the last one is yyyy-MM-dd 24.
3.When the data query granularity is daily, the format is yyyy-MM-dd; the data value of every time slice represents the value of the daily data.
4.Return the time slice contained in start time and the time slice contained in end time |
flowString | Traffic. Keep two digits of decimals. Unit: MB |
Error code
| Error code(code) | Description(message) | HTTP status | Semantic |
|---|---|---|---|
| InvalidDatePeriod | datafrom or dateto not compliant to specifications | 400 | datafrom or dateto not compliant to specifications |
| DateSpanError | Period between datafrom and dateto is longer than 31 days | 400 | Period between datafrom and dateto is longer than 31 days |
| InvalidReportType | Parameter type not compliant to specifications | 400 | Parameter type not compliant to specifications |
| ReportError | System encountered an error(an error returned from log interface, and the error code is neither 200 nor 403) (no longer available, to be deleted) | 400 | System encountered an error(an error returned from log interface, and the error code is neither 200 nor 403) (no longer available, to be deleted) |
| InternalError | System has encountered an error | 500 | System has encountered an error |
Example
JSON
- Request example Copy success
#!/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.atomile.com/api/report/flow?datefrom=2017-11-07T00:00:00%2B00:00&dateto=2017-11-07T00:10:00%2B00:00&type=fiveminutes" \ -X "GET" \ -H "X-Time-Zone:GMT+00:00" \ -u "$username:$password" \ -H "Date: $date" \ -H "Accept: application/json"
- Response example Copy success
{ "flow-summary":"62.18", "flow-data":[ { "timestamp":"2019-07-23 00:05:00", "flow":"31.47" }, { "timestamp":"2019-07-23 00:10:00", "flow":"30.7" } ] }