Get Hit Volume

This API is used to get hit volume with 5 minutes data sample.

1. Request Definition

  • API URL
https://cdn-api.swiftfederation.com/v1.0/report/hit_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, 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 24 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.
hitVolumes HitVolume[] List of hit volume data with 5 minutes interval.
HitVolume 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.
value long Total volume in bytes within 5 minutes. Format will be like 123134.
  • Response Body Example
[
    {
        "domain": "www.example1.com",
        "hitVolumes": [
            {
                "timestamp": "2018-03-29T17:35:00Z",
                "value": 1234123
            }
        ]
    },
    {
        "domain": "www.example2.com",
        "hitVolumes": [
            {
                "timestamp": "2018-03-29T17:35:00Z",
                "value": 123123
            }
        ]
    }
]
           Updated 2024-08-26 07:42:13

results matching ""

    No results matching ""