Get Viewers Location Bandwidth
This API is used to get viewers used bandwidth based on locations with 5 minutes data sample.
1. Request Definition
- API URL
https://cdn-api.swiftfederation.com/v1.0/report/viewers_location_bandwidth
- Request Method
POST
- Request Header
Refer to HTTP Request Headers
- Request Body
Request Body Data Format: JSON
| Field | Required | Type | Description |
|---|---|---|---|
| domains | Mandatory | string[] | Array of domain names, the max array size is 50. |
| startTime | Mandatory | string | Start time. Format yyyy-MM-ddTHH:mm:ssZ UTC time. |
| endTime | Mandatory | string | End time. Format yyyy-MM-ddTHH:mm:ssZ UTC time. Interval between start time and end time cannot be longer than 4 hours. |
- Request Body Example
{
"domains": [
"www.example1.com",
"www.example2.com"
],
"startTime": "2018-03-29T17:35:00Z",
"endTime": "2018-03-29T17:45:00Z"
}
2. Response Definition
- Response Header
Refer to HTTP Response Headers
- Response Body
| Field | Type | Description |
|---|---|---|
| domain | string | Name of domain. |
| viewersLocationBandwidths | ViewersLocationBandwidth[] | List of viewers location bandwidth data with 5 minutes interval. |
| ViewersLocationBandwidth Definition | ||
| timestamp | string | Format yyyy-MM-ddTHH:mm:ssZ UTC time. E.g. 2018-03-29T17:35:00Z will return data from 2018-03-29T17:35:00Z to 2018-03-29T17:39:59Z. |
| locationBandwidths | LocationBandwidth[] | Location bandwidth includes all countries that viewers accessed from and used bandwidth in this country within 5 minutes. |
| LocationBandwidth Definition | ||
| country | string | Country value is country iso code like VN, SG. *ZZ country code means 'Private' viewers location. |
| value | number | Bandwidth value unit is bps and format will be like 1231.34. |
- Response Body Example
[
{
"domain": "www.example1.com",
"viewersLocationBandwidths": [
{
"timestamp": "2018-03-29T17:35:00Z",
"locationBandwidths": [
{
"country": "VN",
"value": 12341.23
},
{
"country": "SG",
"value": 12341.23
}
]
}
]
},
{
"domain": "www.example2.com",
"viewersLocationBandwidths": [
{
"timestamp": "2018-03-29T17:45:00Z",
"locationBandwidths": [
{
"country": "VN",
"value": 12341.23
},
{
"country": "SG",
"value": 12341.23
}
]
}
]
}
]