List of Network Operations Center APIs.
The Noc
service
Method |
Noc.QueryApplicationsActiveMetrics
|
---|---|
Request type |
TimeWindowQuery
|
Response type |
ApplicationsActiveMetrics
|
HTTP bindings |
|
Method |
Noc.QueryApplicationsActive
|
---|---|
Request type |
TimeBucketQuery
|
Response type |
ConnectedTimeBuckets
|
HTTP bindings |
|
Method |
Noc.QueryApplicationsStatistics
|
---|---|
Request type |
TimeWindowQuery
|
Response type |
ApplicationsStatistics
|
HTTP bindings |
|
Method |
Noc.QueryApplicationStatistics
|
---|---|
Request type |
ApplicationTimeWindowQuery
|
Response type |
ApplicationEndDeviceStatistics
|
HTTP bindings |
|
Method |
Noc.QueryApplicationEndDevicesActiveMetrics
|
---|---|
Request type |
ApplicationTimeWindowQuery
|
Response type |
EndDevicesActiveMetrics
|
HTTP bindings |
|
Method |
Noc.QueryApplicationGatewaysSeen
|
---|---|
Request type |
ApplicationTimeWindowQuery
|
Response type |
ApplicationGatewaysSeen
|
HTTP bindings |
|
Method |
Noc.QueryApplicationChannelsPacketCount
|
---|---|
Request type |
ApplicationTimeBucketQuery
|
Response type |
ChannelsPacketCount
|
HTTP bindings |
|
Method |
Noc.QueryApplicationChannelsUtilization
|
---|---|
Request type |
ApplicationTimeBucketQuery
|
Response type |
ChannelsUtilization
|
HTTP bindings |
|
Method |
Noc.QueryApplicationChannelsLoRaPerformance
|
---|---|
Request type |
ApplicationTimeBucketQuery
|
Response type |
ChannelsLoRaPerformance
|
HTTP bindings |
|
Method |
Noc.QueryApplicationDataRatesPacketCount
|
---|---|
Request type |
ApplicationTimeBucketQuery
|
Response type |
DataRatesPacketCount
|
HTTP bindings |
|
Method |
Noc.QueryEndDevicesActive
|
---|---|
Request type |
TimeBucketQuery
|
Response type |
ConnectedTimeBuckets
|
HTTP bindings |
|
Method |
Noc.QueryEndDevicesActiveMetrics
|
---|---|
Request type |
TimeWindowQuery
|
Response type |
EndDevicesActiveMetrics
|
HTTP bindings |
|
Method |
Noc.QueryEndDevicesStatistics
|
---|---|
Request type |
TimeWindowQuery
|
Response type |
EndDevicesStatistics
|
HTTP bindings |
|
Method |
Noc.QueryEndDeviceChannelsPacketCount
|
---|---|
Request type |
EndDeviceTimeBucketQuery
|
Response type |
ChannelsPacketCount
|
HTTP bindings |
|
Method |
Noc.QueryEndDeviceChannelsUtilization
|
---|---|
Request type |
EndDeviceTimeBucketQuery
|
Response type |
ChannelsUtilization
|
HTTP bindings |
|
Method |
Noc.QueryEndDeviceChannelsLoRaPerformance
|
---|---|
Request type |
EndDeviceTimeBucketQuery
|
Response type |
ChannelsLoRaPerformance
|
HTTP bindings |
|
Method |
Noc.QueryEndDeviceDataRatesPacketCount
|
---|---|
Request type |
EndDeviceTimeBucketQuery
|
Response type |
DataRatesPacketCount
|
HTTP bindings |
|
Method |
Noc.QueryEndDevicePacketErrorRate
|
---|---|
Request type |
EndDeviceTimeBucketQuery
|
Response type |
PacketErrorRatesTimeBuckets
|
HTTP bindings |
|
Method |
Noc.QueryEndDeviceSessionStart
|
---|---|
Request type |
EndDeviceTimeBucketQuery
|
Response type |
google.protobuf.Timestamp
|
HTTP bindings |
|
Method |
Noc.QueryEndDeviceLastSeen
|
---|---|
Request type |
EndDeviceTimeBucketQuery
|
Response type |
google.protobuf.Timestamp
|
HTTP bindings |
|
Method |
Noc.GetConfiguration
|
---|---|
Description | Get the configuration of the Network Operations Center. The response is typically used to enable or disable features in a user interface. |
Request type |
GetNocConfigurationRequest
|
Response type |
GetNocConfigurationResponse
|
HTTP bindings |
|
Method |
Noc.QueryGatewaysActiveMetrics
|
---|---|
Request type |
TimeWindowQuery
|
Response type |
GatewaysActiveMetrics
|
HTTP bindings |
|
Method |
Noc.QueryGatewaysConnected
|
---|---|
Request type |
TimeBucketQuery
|
Response type |
ConnectedTimeBuckets
|
HTTP bindings |
|
Method |
Noc.QueryGatewaysConnectivityTimes
|
---|---|
Request type |
TimeWindowQuery
|
Response type |
GatewaysConnectivityTimes
|
HTTP bindings |
|
Method |
Noc.QueryGatewayConnectionEvents
|
---|---|
Request type |
GatewayConnectionEventsQuery
|
Response type |
GatewayConnectionEvents
|
HTTP bindings |
|
Method |
Noc.QueryGatewayChannelsUtilization
|
---|---|
Request type |
GatewayTimeBucketQuery
|
Response type |
ChannelsUtilization
|
HTTP bindings |
|
Method |
Noc.QueryGatewayChannelsLoRaPerformance
|
---|---|
Request type |
GatewayTimeBucketQuery
|
Response type |
ChannelsLoRaPerformance
|
HTTP bindings |
|
Method |
Noc.QueryGatewayChannelsPacketCount
|
---|---|
Request type |
GatewayTimeBucketQuery
|
Response type |
ChannelsPacketCount
|
HTTP bindings |
|
Method |
Noc.QueryGatewayDataRatesPacketCount
|
---|---|
Request type |
GatewayTimeBucketQuery
|
Response type |
DataRatesPacketCount
|
HTTP bindings |
|
Method |
Noc.QueryGatewayTrafficRates
|
---|---|
Request type |
GatewayTimeBucketQuery
|
Response type |
TrafficRatesTimeBuckets
|
HTTP bindings |
|
Method |
Noc.QueryGatewayUptime
|
---|---|
Request type |
GatewayTimeWindowQuery
|
Response type |
google.protobuf.FloatValue
|
HTTP bindings |
|
Method |
Noc.QueryGatewayTopNetworksSeen
|
---|---|
Request type |
GatewayTopNetworksSeenQuery
|
Response type |
GatewayTopNetworksSeen
|
HTTP bindings |
|
Method |
Noc.CheckHealth
|
---|---|
Request type |
google.protobuf.Empty
|
Response type |
google.protobuf.Empty
|
HTTP bindings |
|
Messages
Message ApplicationTimeWindowQuery
Request for application data in a specific time window.
Show object example
{
"application_ids": {},
"time_window": {},
}
Fields:
Field |
application_ids
|
---|---|
Type |
ttn.lorawan.v3.
ApplicationIdentifiers
|
Description |
|
Field |
time_window
|
---|---|
Type |
TimeWindowQuery
|
Description |
|
Message ApplicationTimeBucketQuery
Request for end device data using aggregates by time buckets with a specified interval.
Show object example
{
"application_ids": {},
"time_bucket": {},
}
Fields:
Field |
application_ids
|
---|---|
Type |
ttn.lorawan.v3.
ApplicationIdentifiers
|
Description |
|
Field |
time_bucket
|
---|---|
Type |
TimeBucketQuery
|
Description |
|
Message ApplicationsActiveMetrics
Identifiers of active applications.
Show object example
{
"application_ids": [],
}
Fields:
Field |
application_ids
|
---|---|
Type |
repeated
ttn.lorawan.v3.
ApplicationIdentifiers
|
Description |
Message ApplicationGatewaysSeen
Show object example
{
"gateways": [],
}
Fields:
Field |
gateways
|
---|---|
Type |
repeated
GatewayStatistics
|
Description |
Message ApplicationsStatistic
Applications statistic.
Show object example
{
"application_ids": {},
"active_devices": 0,
"average_packet_error_rate": 0,
}
Fields:
Field |
application_ids
|
---|---|
Type |
ttn.lorawan.v3.
ApplicationIdentifiers
|
Field |
active_devices
|
---|---|
Type |
uint32
|
Field |
average_packet_error_rate
|
---|---|
Type |
float
|
Message ApplicationsStatistics
Applications statistics.
Show object example
{
"stats": [],
}
Fields:
Field |
stats
|
---|---|
Type |
repeated
ApplicationsStatistic
|
Description |
Message ApplicationEndDeviceStatistics
Application end devices statistics.
Show object example
{
"stats": [],
}
Fields:
Field |
stats
|
---|---|
Type |
repeated
ApplicationEndDeviceStatistic
|
Description |
Message ApplicationEndDeviceStatistic
Application end devices statistic.
Show object example
{
"end_device_ids": {},
"last_seen": "0001-01-01T00:00:00Z",
"last_packet_error_rate": 0,
"best_gateway_ids": {},
"best_channel_rssi": 0,
"packet_count": 0,
}
Fields:
Field |
end_device_ids
|
---|---|
Type |
ttn.lorawan.v3.
EndDeviceIdentifiers
|
Field |
last_seen
|
---|---|
Type |
google.protobuf.
Timestamp
|
Field |
last_packet_error_rate
|
---|---|
Type |
float
|
Field |
best_gateway_ids
|
---|---|
Type |
ttn.lorawan.v3.
GatewayIdentifiers
|
Field |
best_channel_rssi
|
---|---|
Type |
float
|
Field |
packet_count
|
---|---|
Type |
uint64
|
Message ChannelUtilization
Utilization per channel.
Show object example
{
"time": "0001-01-01T00:00:00Z",
"utilization": {},
}
Fields:
Field |
time
|
---|---|
Type |
google.protobuf.
Timestamp
|
Description |
|
Field |
utilization
|
---|---|
Type |
map of
uint64
to
float
|
Description |
Utilization (fraction of time) per frequency (Hz) that the channel is in use. |
Message ChannelsUtilization
Utilizations of channels.
Show object example
{
"channels": [],
}
Fields:
Field |
channels
|
---|---|
Type |
repeated
ChannelUtilization
|
Description |
Message ChannelLoRaPerformance
LoRa performance per channel.
Show object example
{
"time": "0001-01-01T00:00:00Z",
"agg_lora_rssi": {},
}
Fields:
Field |
time
|
---|---|
Type |
google.protobuf.
Timestamp
|
Description |
|
Field |
agg_lora_rssi
|
---|---|
Type |
map of
uint64
to
float
|
Description |
Aggregated observed LoRa RSSI (channel RSSI adjusted for SNR) per frequency (Hz). |
Message ChannelsLoRaPerformance
LoRa performance of channels.
Show object example
{
"channels": [],
}
Fields:
Field |
channels
|
---|---|
Type |
repeated
ChannelLoRaPerformance
|
Description |
Message ChannelPacketCount
Packet count per channel.
Show object example
{
"time": "0001-01-01T00:00:00Z",
"count": {},
}
Fields:
Field |
time
|
---|---|
Type |
google.protobuf.
Timestamp
|
Description |
|
Field |
count
|
---|---|
Type |
map of
uint64
to
uint64
|
Description |
Packet counts per frequency (Hz). |
Message ChannelsPacketCount
Packet counts of channels.
Show object example
{
"channels": [],
}
Fields:
Field |
channels
|
---|---|
Type |
repeated
ChannelPacketCount
|
Description |
Message ChannelsUtilization
Utilizations of channels.
Show object example
{
"channels": [],
}
Fields:
Field |
channels
|
---|---|
Type |
repeated
ChannelUtilization
|
Description |
Message ConnectedTimeBucket
Number of entities connected in a time bucket.
Show object example
{
"time": "0001-01-01T00:00:00Z",
"count": 0,
}
Fields:
Field |
time
|
---|---|
Type |
google.protobuf.
Timestamp
|
Description |
|
Field |
count
|
---|---|
Type |
uint32
|
Message ConnectedTimeBuckets
Number of entities connected.
Show object example
{
"hourly_buckets": [],
"daily_buckets": [],
"weekly_buckets": [],
}
Fields:
Field |
hourly_buckets
|
---|---|
Type |
repeated
ConnectedTimeBucket
|
Description |
Field |
daily_buckets
|
---|---|
Type |
repeated
ConnectedTimeBucket
|
Description |
Field |
weekly_buckets
|
---|---|
Type |
repeated
ConnectedTimeBucket
|
Description |
Message EndDeviceTimeBucketQuery
Request for end device data using aggregates by time buckets with a specified interval.
Show object example
{
"end_device_ids": {},
"time_bucket": {},
}
Fields:
Field |
end_device_ids
|
---|---|
Type |
ttn.lorawan.v3.
EndDeviceIdentifiers
|
Description |
|
Field |
time_bucket
|
---|---|
Type |
TimeBucketQuery
|
Description |
|
Message EndDevicesActiveMetrics
Identifiers of active end devices.
Show object example
{
"end_device_ids": [],
}
Fields:
Field |
end_device_ids
|
---|---|
Type |
repeated
ttn.lorawan.v3.
EndDeviceIdentifiers
|
Description |
Message EndDevicesStatistics
End devices statistics.
Show object example
{
"stats": [],
}
Fields:
Field |
stats
|
---|---|
Type |
repeated
EndDevicesStatistic
|
Description |
Message EndDevicesStatistic
End devices statistic.
Show object example
{
"end_device_ids": {},
"application_ids": {},
"last_seen": "0001-01-01T00:00:00Z",
"last_packet_error_rate": 0,
}
Fields:
Field |
end_device_ids
|
---|---|
Type |
ttn.lorawan.v3.
EndDeviceIdentifiers
|
Field |
application_ids
|
---|---|
Type |
ttn.lorawan.v3.
ApplicationIdentifiers
|
Field |
last_seen
|
---|---|
Type |
google.protobuf.
Timestamp
|
Field |
last_packet_error_rate
|
---|---|
Type |
float
|
Message DataRatePacketCount
Show object example
{
"time": "0001-01-01T00:00:00Z",
"count": {},
}
Fields:
Field |
time
|
---|---|
Type |
google.protobuf.
Timestamp
|
Description |
|
Field |
count
|
---|---|
Type |
map of
string
to
uint64
|
Description |
Packet counts per data rate. |
Message DataRatesPacketCount
Show object example
{
"data_rates": [],
}
Fields:
Field |
data_rates
|
---|---|
Type |
repeated
DataRatePacketCount
|
Description |
Message GatewayConnectionEventTypeValue
Show object example
{
"value": "GATEWAY_CONNECTION_EVENT_TYPE_CONNECT",
}
Fields:
Field |
value
|
---|---|
Type |
GatewayConnectionEventType
|
Description |
|
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 |
|
Field |
event_type
|
---|---|
Type |
GatewayConnectionEventTypeValue
|
Description |
The event type to query. If unset, query all event types. |
Message GatewayStatistics
Show object example
{
"gateway_id": {},
"best_channel_rssi": 0,
"packet_count": 0,
}
Fields:
Field |
gateway_id
|
---|---|
Type |
ttn.lorawan.v3.
GatewayIdentifiers
|
Field |
best_channel_rssi
|
---|---|
Type |
float
|
Field |
packet_count
|
---|---|
Type |
uint64
|
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 |
|
Field |
time_bucket
|
---|---|
Type |
TimeBucketQuery
|
Description |
|
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 |
|
Field |
time_window
|
---|---|
Type |
TimeWindowQuery
|
Description |
|
Message GatewayTopNetworksSeen
Networks seen by a gateway.
Show object example
{
"networks": {},
}
Fields:
Field |
networks
|
---|---|
Type |
map of
string
to
float
|
Description |
Proportion of network by name. The proportions are a fraction of 1. The remaining number is the rest total. |
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 |
|
Field |
top
|
---|---|
Type |
uint32
|
Description |
Top number of networks to include.
|
Message GatewaysActiveMetrics
Identifiers of active gateways.
Show object example
{
"gateway_ids": [],
}
Fields:
Field |
gateway_ids
|
---|---|
Type |
repeated
ttn.lorawan.v3.
GatewayIdentifiers
|
Description |
Message GatewayConnectionEvent
Gateway connection event.
Show object example
{
"time": "0001-01-01T00:00:00Z",
"event_type": "GATEWAY_CONNECTION_EVENT_TYPE_CONNECT",
}
Fields:
Field |
time
|
---|---|
Type |
google.protobuf.
Timestamp
|
Description |
|
Field |
event_type
|
---|---|
Type |
GatewayConnectionEventType
|
Description |
|
Message GatewayConnectionEvents
Gateway connection events.
Show object example
{
"events": [],
}
Fields:
Field |
events
|
---|---|
Type |
repeated
GatewayConnectionEvent
|
Description |
Message GatewayConnectivityTimes
Connectivity times of a gateway.
Show object example
{
"gateway_ids": {},
"last_connect": "0001-01-01T00:00:00Z",
"last_disconnect": "0001-01-01T00:00:00Z",
"uptime": 0,
"packet_rate_last_hour": 0,
"disconnects": 0,
}
Fields:
Field |
gateway_ids
|
---|---|
Type |
ttn.lorawan.v3.
GatewayIdentifiers
|
Description |
|
Field |
last_connect
|
---|---|
Type |
google.protobuf.
Timestamp
|
Field |
last_disconnect
|
---|---|
Type |
google.protobuf.
Timestamp
|
Field |
uptime
|
---|---|
Type |
float
|
Description |
Fraction of time that the gateway was active. This is typically aggregated in time buckets of at least 5 minutes or 1 hour depending on the query window. |
Field |
packet_rate_last_hour
|
---|---|
Type |
float
|
Description |
Packet rate (uplink and downlink) of the last hour. |
Field |
disconnects
|
---|---|
Type |
uint64
|
Description |
Number of disconnects. |
Message GatewaysConnectivityTimes
Connectivity times of gateways.
Show object example
{
"gateways": [],
}
Fields:
Field |
gateways
|
---|---|
Type |
repeated
GatewayConnectivityTimes
|
Description |
Message GetNocConfigurationRequest
Show object example
{
}
Fields:
Message GetNocConfigurationResponse
Show object example
{
"configuration": {},
}
Fields:
Field |
configuration
|
---|---|
Type |
NocConfiguration
|
Message NocConfiguration
Show object example
{
"access": {},
}
Fields:
Field |
access
|
---|---|
Type |
NocConfiguration.Access
|
Message NocConfiguration.Access
Show object example
{
"extended": null,
}
Fields:
Field |
extended
|
---|---|
Type |
google.protobuf.
BoolValue
|
Message PacketErrorRatesTimeBuckets
Show object example
{
"packet_error_rates": [],
}
Fields:
Field |
packet_error_rates
|
---|---|
Type |
repeated
PacketErrorRatesTimeBuckets.PacketErrorRate
|
Description |
Message PacketErrorRatesTimeBuckets.PacketErrorRate
Show object example
{
"time": "0001-01-01T00:00:00Z",
"packet_error_rate": 0,
}
Fields:
Field |
time
|
---|---|
Type |
google.protobuf.
Timestamp
|
Description |
|
Field |
packet_error_rate
|
---|---|
Type |
float
|
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 |
|
Field |
to
|
---|---|
Type |
google.protobuf.
Timestamp
|
Description |
|
Field |
bucket_interval
|
---|---|
Type |
google.protobuf.
Duration
|
Description |
|
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 |
|
Field |
to
|
---|---|
Type |
google.protobuf.
Timestamp
|
Description |
|
Message TrafficRatesTimeBuckets
Uplink and downlink message rates over time.
Show object example
{
"uplink": [],
"downlink": [],
}
Fields:
Field |
uplink
|
---|---|
Type |
repeated
TrafficRatesTimeBuckets.Direction
|
Description |
Field |
downlink
|
---|---|
Type |
repeated
TrafficRatesTimeBuckets.Direction
|
Description |
Message TrafficRatesTimeBuckets.Direction
Show object example
{
"time": "0001-01-01T00:00:00Z",
"rate": 0,
}
Fields:
Field |
time
|
---|---|
Type |
google.protobuf.
Timestamp
|
Description |
|
Field |
rate
|
---|---|
Type |
float
|
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. |