Panel Pro Capture waveforms

get

https://api.verdigris.co/data/v4/events/pro-capture/buildings/{buildingId}/panels/{panelId}/waveforms

Gets Pro Capture waveforms that

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

buildingId

integer

required

Building ID

panelId

integer

required

Panel ID

Query Params

start_time

date-time

required

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

end_time

date-time

required

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

limit

integer

≥ 1

Caps the response to the most recent limit events in the query time range, ordered by descending timestamp. When omitted, every event in the range is returned. Ignored when event_timestamp is supplied, since that already selects a single event.

event_timestamp

date-time

Projects the result to the single event at this exact timestamp within the query time range. Accepts an ISO 8601 string or an integer UNIX epoch in milliseconds. If no event matches, the response is an empty collection (not a 404). Takes precedence over limit.

timestamp_format

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:

timezone

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.

Responses

Note

401Request to resource is unauthorized. This is likely due to missing access token in the Authorization header or an invalid token signature usually as a result of attempted token forgery by an unauthorized third-party.

403Request to resource is forbidden due to insufficient permissions.

404Resource with given ID cannot be found.

422One or more validations for request has failed.