Gateway Performance Management

Gateway Performance endpoints show the telemetry that was received from the Gateway.

How to get telemetry for single Gateway

GET performance by Gateway ID

/api/gateway/{gatewayId}/performance/{measurement}/{field}?startMs=1699285213000&stopMs=1699286213000&order=DESC&limit=2

{gatewayId} = gateway ID
measurement = Performance Measure (e.g. battery)
field = specific performance measure (e.g. chargerInputVoltage)
{startMs} = the timestamp to start sampling (in milliseconds)
{stopMs} = the timestamp at which you want to end the sample (in milliseconds)
{order} = order (ASC or DESC)
{limit} = limit of entries

Response Body:

In the response, up to limit entries are returned. Pagination is achieved by making subsequent requests with the updated startMs/stopMs parameters (by specifying the last timestamp that was received in response).

Response body:

[
{
  "timeMs" : 1699279304325,
  "value" : 23.23
},
{
  "timeMs" : 1699279316777,
  "value" : 23.23
},
...
]

How to get telemetry for different Gateways

GET Gateway’s performance by Cutomer:

/api/gatewayPerformance/customer/{customerId}/{measurement}/{field}?startMs=1699285213000&stopMs=1699286213000&showTags=customerId,gatewayMac&order=DESC&limit=100

GET Gateway’s performance by Provider:

/api/gatewayPerformance/provider/{providerId}/{measurement}/{field}?startMs=1699285213000&stopMs=1699286213000&showTags=customerId,gatewayMac&order=DESC&limit=100

GET Gateway’s performance by Gateway Group:

GET /api/gatewayPerformance/gatewayGroup/{gatewayGroupId}/{measurement}/{field}?startMs=1699285213000&stopMs=1699286213000&showTags=customerId,gatewayMac&order=DESC&limit=100

{customerId} = customer ID
{providerId} = provider ID
{gatewayGroupId} = Gateway Group ID
measurement = Performance Measure (e.g. battery)
field = specific performance measure (e.g. chargerInputVoltage)
{startMs} = the timestamp to start sampling (in milliseconds)
{stopMs} = the timestamp at which you want to end the sample (in milliseconds)
{order} = order (ASC or DESC)
{limit} = limit of entries
{showTags} = comma-separated set of tags to show. Available tags: period, gatewayMac, gatewayId, customerId, providerId, gatewayGroupId

Response body:

[
{
  "timeMs" : 1699279304325,
  "value" : 23.23,
  "tags" : {
    "gatewayMac" : "AAAABBBBDDDD",
    "gatewayId" : "11565620e9209e2343498347"
  }
},
{
  "timeMs" : 1699279316777,
  "value" : 23.23,
  "tags" : {
    "gatewayMac" : "AAAABBBBDDDD",
    "gatewayId" : "11565620e9209e2343498347"
  }
},
...
]