HomeGuidesAPI Reference
API Reference

Get power supply time series statistics for an appliance

Retrieves power supply consumption statistics for a single appliance over a specified time range. The response contains time-series data with power readings (in watts) at each timestamp. Data aggregation varies by granularity: minute returns raw readings, hour and day return aggregated sums.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required
^\d+\.NE$

Network Element Primary Key - unique appliance identifier assigned by Orchestrator. Format: '.NE' (e.g., '0.NE', '10.NE').

int64
required
≥ 0

Unix timestamp (seconds since epoch) for the start of the time range. Must be >= 0 and less than endTime.

int64
required
≥ 0

Unix timestamp (seconds since epoch) for the end of the time range. Must be >= 0 and greater than startTime.

string
enum
required

Data aggregation granularity. Determines how data points are grouped over time.

Allowed:
integer
≥ 1

Maximum number of stats records to retrieve. Optional parameter for limiting results.

Responses

401

Unauthorized - Authentication required or invalid credentials

403

Forbidden - User does not have READ or READ_WRITE permissions

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json