Get data by device

post

https://core.hivelocity.net/api/v2/bandwidth/device/{deviceId}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Returns information about a specified device ID's bandwidth data over a specified time period.

Path Params

deviceId

integer

required

ID of Device to View

Query Params

period

string

enum

required

Defaults to day

Return data in the given period. Day, week, month will return the previous day, week, month from now.

Allowed:

interface

string

enum

required

Defaults to eth0

Network interface to get bandwidth usage from. eth0 and eth1 are your first and second nic respectively. If unsure use the public, private, and all values. Overages are billed on public traffic.

Allowed:

historical

boolean

Defaults to false

If you are a reseller, this will include historical interface data for device regardless of the current device owner.

step

integer

required

Defaults to 300

Interval of data in seconds. Historical data is condensed, if provided value is smaller than existing steps for the date range the endpoint will return data with the smallest available step.

start

integer

Defaults to 0

Start time of custom time period. (Unix Epoch Time)

end

integer

Defaults to 1783022995

End time of custom time period (Unix Epoch Time)

Headers

X-Fields

string

An optional fields mask

Responses

400

Unable to retrieve Bandwidth Graph for this Device.

403

You have not been granted permission to complete this action. Please contact your account manager to grant the proper permission.

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Device Bandwidth Graph retrieved.