API Reference

get gateway status v1 series

get
https://api.data.everactive.com/ds/v1/evergateways//status/v1

Retrieve a list of v1 status messages for a gateway, suitable for users to view.

This call is not intended for downloading large volumes of data. It returns a maximum of 5000 data points.

You can control the amount of data to collect by setting the date range and downsample rate.

  • If the requested time period and downsample rate will produce a payload that exceeds the maximum of 5000 data points, the body of the response contains an error message.
  • If the request does not specify a downsample rate, the call calculates a rate that results in a number of data points close to the maximum. The expected number of status messages assumes 1 status message every 5 minutes.

On success, the body of the response contains both the data and a summary of the start and end dates, the returned item count, and the downsampleRate used.

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

The serial number or unique ID of the gateway.

Query Params
int64
required
≥ 0

The start time for the time series data. Inclusive. A UNIX timestamp, seconds from 1970-01-01.

int64

The end time for the time series data. Inclusive. A UNIX timestamp, seconds from 1970-01-01.

int32
> 0

The number of seconds for the downsample interval. (3600 = 1 hour).

Responses

401

The request did not include the correct authorization or the included authorization has expired.

403

The requested resource is not accessible to the currently authenticated client.

404

The requested resource was not found.

Updated 7 months ago

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

Updated 7 months ago