Get Viewers Location Volume

This API is used to get viewers used volume based on locations with 5 minutes or one day data sample.

1. Request Definition

  • API URL
https://cdn-api.swiftfederation.com/v1.0/report/viewers_location_volume
  • 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. If interval is "minute", interval between start time and end time cannot be longer than 4 hours. If interval is "day", interval between start time and end time cannot be longer than 30 days.
interval Optional string Interval of data spot, could be "minute", "day". For "minute", data spot is for 5 minutes, and for "day", data spot is one day. Default is "minute".
  • 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.
viewersLocationVolumes ViewersLocationVolume[] List of viewers location volume data with 5 minutes interval.
ViewersLocationVolume 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.
locationVolumes LocationVolume[] Location volume includes all countries that viewers accessed from and used volume in this country.
LocationVolume Definition
country string Country value is country iso code like VN, SG.
value number Volume value unit is byte and format will be like 123134.
  • Response Body Example
[
    {
        "domain": "www.example1.com",
        "viewersLocationVolumes": [
            {
                "timestamp": "2018-03-29T17:35:00Z",
                "locationVolumes": [
                    {
                        "country": "VN",
                        "value": 1234123
                    },
                    {
                        "country": "SG",
                        "value": 1234123
                    }
                ]
            }
        ]
    },
    {
        "domain": "www.example2.com",
        "viewersLocationVolumes": [
            {
                "timestamp": "2018-03-29T17:45:00Z",
                "locationVolumes": [
                    {
                        "country": "VN",
                        "value": 1234123
                    },
                    {
                        "country": "SG",
                        "value": 1234123
                    }
                ]
            }
        ]
    }
]
© 2019 Conversant Solutions Pte Ltd. All rights reserved.            Updated 2019-09-18 06:08:48

results matching ""

    No results matching ""