Get Viewers Location Hit Request

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

1. Request Definition

  • API URL
https://cdn-api.swiftfederation.com/v1.0/report/viewers_location_hit_request
  • 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.
viewersLocationRequests ViewersLocationRequest[] List of viewers location hit request data with 5 minutes interval.
ViewersLocationRequest 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.
locationRequests LocationRequest[] Location request includes all countries that viewers accessed from and used request in this country within 5 minutes.
LocationRequest Definition
country string Country value is country iso code like VN, SG.
value number Number of requests, format will be like 1342323.
  • Response Body Example
[
    {
            "domain": "www.example1.com",
            "viewersLocationRequests": [
                {
                    "timestamp": "2018-03-29T17:35:00Z",
                    "locationRequests": [
                        {
                            "country": "VN",
                            "value": 29952
                        },
                        {
                            "country": "SG",
                            "value": 26315
                        }
                    ]
                }
            ]
        },
        {
            "domain": "www.example2.com",
            "viewersLocationRequests": [
                {
                    "timestamp": "2018-03-29T17:45:00Z",
                    "locationRequests": [
                        {
                            "country": "VN",
                            "value": 29952
                        },
                        {
                            "country": "SG",
                            "value": 26315
                        }
                    ]
                }
            ]
        }
]
© 2019 Conversant Solutions Pte Ltd. All rights reserved.            Updated 2019-07-01 05:34:37

results matching ""

    No results matching ""