Endpoint data

List endpoint data recorded since a sequence number

Returns readings whose SequenceNumber is higher than the one sent. Send one, and only one, of clientID, facilityID, deviceID or endpointID, and keep the same filter between calls.

get/api/v2/endpointData/incremental/{sequenceNumber}

Request

  • Base URL: https://gear.cloud.studio
  • URL: https://gear.cloud.studio/api/v2/endpointData/incremental/{sequenceNumber}
  • Auth: one of:
    • HTTP bearer
    • API key in query parameter accessToken

Path parameters

sequenceNumberinteger required

SequenceNumber of the last item received. Use 0 to start from the beginning.

Query parameters

clientIDinteger

Only items of this client.

facilityIDinteger

Only items of this facility.

deviceIDinteger

Only items of this device.

endpointIDinteger

Only items of this endpoint.

maxCountinteger

Maximum number of records in the result. Values above 500 are limited to 500.

Response

Readings recorded since sequenceNumber. An empty list means there is nothing new.

EndpointIDinteger
Timestamp_UTCstring
Valuenumber double

Numeric value. Scalar endpoints and IAS zones.

IsOnboolean

Appliances and dimmers.

IsMovingboolean

Closures.

DimLevelinteger

Dimmers.

Positioninteger

Closure controllers.

ActiveEnergynumber double

Power meters.

ReactiveEnergynumber double

Power meters.

ApparentEnergynumber double

Power meters.

SequenceNumberinteger

Changes

No recorded changes to this operation across all 1 revision of this API.