Getting the total amount of traffic for all domains¶

Note

The user must have at least READ permissions during the selected time period.

Sends a GET request to the endpoint /statistics/total-domain-traffic/{startTime}/{finishTime}.

Description¶

The Get-Total-Traffic request allows the user to request a statistic of the total traffic of all domains for the selected time period.

Values of the request: Start Date {startTime}; End Date {finishTime}

Objects: none

To get a statistic of the total traffic of all domains, the start time and end time as unix timestamp need to be added to the path of the request.

As a result, the user gets the objects graph with data for each analysis category for a graphical visualisation.

The object graph provides the following information:

Attributes	Description	Values
`total_traffic`	The total amount of traffic.	`integer`
`total_cached_traffic`	The total amount of cached traffic.	`integer`
`total_uncached_traffic`	The total amount of uncached traffic.	`integer`

The graphical visualisation under each attribute provides the following information:

Attributes	Description	Values
`x`	The date and time for the data point.	`integer` as unix timestamp
`y`	The number of requests to the related data point.	`integer`

Example response:

{
  "total_traffic": 0,
  "total_cached_traffic": 0,
  "total_uncached_traffic": 0,
  "x": 0,
  "y": 0
}

The following responses are available:

STATUS CODE	DESCRIPTION
200	The request has succeeded.
400	The request was unsuccessful. The request was invalid or information is missing.
401	The request has not succeeded because the user authentication was incorrect.
403	The request has not succeeded because the user does not have the right permissions.