Circuit current waveform

Gets current waveform for a circuit.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required

Circuit ID

Query Params
date-time
required

Start of the query time range. Must be ISO 8601 formatted.

date-time
required

End of the query time range. Must be ISO 8601 formatted.

string | null
enum

Format timestamps in the data. If set to ISO8601 (case-insensitive), the timestamp is returned as a string formatted in ISO 8601 format. If omitted, the timestamp is returned as an integer representing UNIX epoch.

Allowed:
string
Defaults to UTC

When used in conjunction with timestamp_format query parameter that is set to ISO8601 format, specifying the zone ID of IANA Time Zone Database returns the timestamp in the time zone offset.

Setting the timezone when timestamp_format is not specified has no affect on the UNIX epoch timestamp.

Note

This query parameter meant to be a convenience feature that only affects the display format of the timestamps in the result. It has no affect on the building’s timezone.

Headers
string
enum
Defaults to application/json

Specify a MIME type to indicate the content type the client would like to receive the data in. If omitted, defaults to application/json.

Currently, the supported formats are:

  • application/json
  • text/csv
Allowed:
Responses

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