Power Usage (Power Circuit Historical)

/api/v1/usage/powerCircuit

GET
Request generation of power usage data for a power circuit 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.

When requesting power from a circuit that is a member of a circuit pair, three data points will be returned for each 5 minute interval (one for the primary, one for the redundant, and one for the combined total of the pair).

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 power circuit

-

integer (int32)

powerType

query

yes

The type of power to return.

Allowable values: AMPS, KW

AMPS

string

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

-

string (date-time)

 

Response
Content-Type: application/json

Status Code Reason Response Model

200

Success

integer(int32)

400

Bad Request

-

401

Unauthorized

-

500

Failure

-