Bandwidth Usage (Historical)

/api/v1/usage/bandwidth

GET
Request generation of bandwidth usage of a bandwidth service over time. The return values are in 5 minute increments for the given date range. If the call is successful, the response is a results id, which must be used as a parameter for a subsequent call /api/v1/usage/results to obtain the usage data.

The date range specified must be 100 days or less.

Request
Parameters

Name Located in Required Description Default Schema

inventoryid

query

yes

The inventory id of the bandwidth service

-

integer (int32)

start

query

yes

The start date in UTC, i.e. 1/01/2019 5:20 PM

-

string (date-time)

end

query

yes

The end date in UTC, i.e. 1/31/2019 5:20 PM

NOTE: The date range specified must be 100 days or less.

-

string (date-time)

 

Response
Content-Type: application/json

Status Code Reason Response Model

200

Success

results id

400

Bad Request

-

401

Unauthorized

-

500

Failure

-