Network Operations Center APIs

The Noc service

Method Noc.QueryGatewaysConnected
Request type TimeBucketQuery
Response type GatewaysConnectedTimeBuckets
HTTP bindings

POST /api/v3/noc/gateways/connected
Method Noc.QueryGatewaysConnectivityTimes
Request type TimeWindowQuery
Response type GatewaysConnectivityTimes
HTTP bindings

POST /api/v3/noc/gateways/connectivity
Method Noc.QueryGatewaysActive
Request type TimeWindowQuery
Response type GatewaysActive
HTTP bindings

POST /api/v3/noc/gateways/active
Method Noc.QueryGatewayConnectionEvents
Request type GatewayConnectionEventsQuery
Response type GatewayConnectionEvents
HTTP bindings

POST /api/v3/noc/gateway/{gateway_time_window.gateway_ids.gateway_id}/connection-events
Method Noc.QueryGatewayChannelsUtilization
Request type GatewayTimeBucketQuery
Response type GatewayChannelsUtilization
HTTP bindings

POST /api/v3/noc/gateway/{gateway_ids.gateway_id}/channels/utilization
Method Noc.QueryGatewayChannelsLoRaPerformance
Request type GatewayTimeBucketQuery
Response type GatewayChannelsLoRaPerformance
HTTP bindings

POST /api/v3/noc/gateway/{gateway_ids.gateway_id}/channels/lora-performance
Method Noc.QueryGatewayChannelsPacketCount
Request type GatewayTimeBucketQuery
Response type ChannelsPacketCount
HTTP bindings

POST /api/v3/noc/gateway/{gateway_ids.gateway_id}/channels/packet-count
Method Noc.QueryGatewayTrafficRates
Request type GatewayTimeBucketQuery
Response type TrafficRatesTimeBuckets
HTTP bindings

POST /api/v3/noc/gateway/{gateway_ids.gateway_id}/traffic
Method Noc.QueryGatewayUptime
Request type GatewayTimeWindowQuery
Response type google.protobuf.FloatValue
HTTP bindings

POST /api/v3/noc/gateway/{gateway_ids.gateway_id}/uptime
Method Noc.QueryGatewayTopNetworksSeen
Request type GatewayTopNetworksSeenQuery
Response type GatewayTopNetworksSeen
HTTP bindings

POST /api/v3/noc/gateway/{gateway_time_window.gateway_ids.gateway_id}/networks-seen/top/{top}
Method Noc.CheckHealth
Request type google.protobuf.Empty
Response type google.protobuf.Empty
HTTP bindings

GET /api/v3/noc/health

Messages

Message GatewayConnectionEventTypeValue

Show object example 
{
  "value": "GATEWAY_CONNECTION_EVENT_TYPE_CONNECT",
}

Fields:

Field value
Type GatewayConnectionEventType
Description

defined_only

Message GatewaysConnectedTimeBuckets

Number of gateways connected.

Show object example 
{
  "buckets": [],
}

Fields:

Field buckets
Type repeated GatewaysConnectedTimeBucket
Description

Message GatewaysConnectedTimeBucket

Number of gateways connected in a time bucket.

Show object example 
{
  "time": "0001-01-01T00:00:00Z",
  "count": 0,
}

Fields:

Field time
Type google.protobuf. Timestamp
Description

required
Field count
Type uint32

Message TimeBucketQuery

Request for data using aggregates by time buckets with a specified interval.

Show object example 
{
  "from": "0001-01-01T00:00:00Z",
  "to": "0001-01-01T00:00:00Z",
  "bucket_interval": "0s",
}

Fields:

Field from
Type google.protobuf. Timestamp
Description

required
Field to
Type google.protobuf. Timestamp
Description

required
Field bucket_interval
Type google.protobuf. Duration
Description

gt: 0s

Message TimeWindowQuery

Request for data in a specific time window.

Show object example 
{
  "from": "0001-01-01T00:00:00Z",
  "to": "0001-01-01T00:00:00Z",
}

Fields:

Field from
Type google.protobuf. Timestamp
Description

required
Field to
Type google.protobuf. Timestamp
Description

required

Message GatewayConnectionEventsQuery

Request for gateway connection events in a specific time window.

Show object example 
{
  "gateway_time_window": {},
  "event_type": {},
}

Fields:

Field gateway_time_window
Type GatewayTimeWindowQuery
Description

required
Field event_type
Type GatewayConnectionEventTypeValue
Description

The event type to query. If unset, query all event types.

Message GatewayTimeBucketQuery

Request for gateway data using aggregates by time buckets with a specified interval.

Show object example 
{
  "gateway_ids": {},
  "time_bucket": {},
}

Fields:

Field gateway_ids
Type ttn.lorawan.v3. GatewayIdentifiers
Description

required
Field time_bucket
Type TimeBucketQuery
Description

required

Message GatewayTimeWindowQuery

Request for gateway data in a specific time window.

Show object example 
{
  "gateway_ids": {},
  "time_window": {},
}

Fields:

Field gateway_ids
Type ttn.lorawan.v3. GatewayIdentifiers
Description

required
Field time_window
Type TimeWindowQuery
Description

required

Message GatewayTopNetworksSeenQuery

Request for top network seen by a gateway.

Show object example 
{
  "gateway_time_window": {},
  "top": 0,
}

Fields:

Field gateway_time_window
Type GatewayTimeWindowQuery
Description

required
Field top
Type uint32
Description

Top number of networks to include.

gte: 1

Enums

Enum GatewayConnectionEventType

Gateway connection event type.

Name Value Description
GATEWAY_CONNECTION_EVENT_TYPE_CONNECT 0 The gateway connects.
GATEWAY_CONNECTION_EVENT_TYPE_DISCONNECT 1 The gateway disconnects.
GATEWAY_CONNECTION_EVENT_TYPE_STATS 2 The gateway connection statistics are updated.
← Gateway Server MQTT Network Server APIs →