Sign in

v1

latestOpenAPI 3.0.02026-07-243339471.1 MB
Gateways

Get gateway uplink modem stats

Retrieves modem statistics data for the specified gateway.

get/network-monitoring/v1/gateways/{serial-number}/modem-stat

Path parameters

serial-numberstring required

The gateway serial number.

Example:GW00000001

Serial number of the gateway device.

Query parameters

site-idstring uuid

Id of a site where devices are associated.

Example:24833497

ID of the site for which gateway-related information is requested.

Response

The response object provides modem stats for the specified gateway.

arfcn3ginteger required

Absolute Radio Frequency Channel Number for 3G networks.

arfcnLteinteger required

Absolute Radio Frequency Channel Number for LTE networks.

cqiinteger required

Channel Quality Indicator representing the quality of the wireless channel.

dataBillinginteger required

It indicates the start date of the monthly billing cycle.

dataLimitstring required

Data limit for the modem connection.

dataUsagestring required

Data usage for the modem connection.

rscp3gstring required

Received Signal Code Power for 3G networks.

rsrpLtestring required

Reference Signal Received Power for LTE networks.

rsrqstring required

Reference Signal Received Quality for LTE networks.

rssistring required

Received Signal Strength Indicator for the modem connection.

signalStrengthinteger required

Signal-to-Interference-plus-Noise Ratio for the modem connection.

idstring required

Primary identifier for the resource.

typestring required

The type of the resource.

Example response

{
  "arfcn3g": 0,
  "arfcnLte": 1615,
  "cqi": 0,
  "dataBilling": 1,
  "dataLimit": "60 MB",
  "dataUsage": "90 MB",
  "rscp3g": "0 dBm",
  "rsrpLte": "-91 dBm",
  "rsrq": "-13 dBm",
  "rssi": "-61 dBm",
  "signalStrength": 9,
  "id": "GW00000001",
  "type": "network-monitoring/gateway-monitoring"
}