Get Viewers Location Origin Bandwidth

This API is used to get viewers used origin bandwidth based on locations with 5 minutes data sample.

1. Request Definition

  • API URL
https://cdn-api.swiftfederation.com/v1.0/report/viewers_location_origin_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.
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 origin 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.
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
                    }
                ]
            }
        ]
    }
]
© 2019 Conversant Solutions Pte Ltd. All rights reserved.            Updated 2019-05-23 03:46:25

results matching ""

    No results matching ""