Getting Started Concepts The Things Stack Cloud The Things Stack Enterprise Integrations API Hardware
Get The Things Stack

API

    Overview
  • Concepts
  • Reference
    • HTTP(REST)
    • gRPC
      • Application APIs
      • Application Package APIs
      • Application Pub/Sub APIs
      • Application Server APIs
      • Application Webhook APIs
      • Client APIs
      • Crypto Operations APIs
      • End Device APIs
      • Events API
      • Gateway APIs
      • Gateway Server APIs
      • Identity Server APIs
      • Join Server APIs
      • Network Operations Center APIs
      • Network Server APIs
      • Organization APIs
      • Packet Broker APIs
      • Storage Integration API
      • Tenant APIs
      • User APIs

Network Operations Center APIs

List of Network Operations Center APIs.

The Noc service

Method Noc.QueryApplicationsActiveMetrics
Request type TimeWindowQuery
Response type ApplicationsActiveMetrics
HTTP bindings

POST /api/v3/noc/applications/active-metrics

Method Noc.QueryApplicationsActive
Request type TimeBucketQuery
Response type ConnectedTimeBuckets
HTTP bindings

POST /api/v3/noc/applications/active

Method Noc.QueryApplicationsStatistics
Request type TimeWindowQuery
Response type ApplicationsStatistics
HTTP bindings

POST /api/v3/noc/applications/statistics

Method Noc.QueryApplicationStatistics
Request type ApplicationTimeWindowQuery
Response type ApplicationEndDeviceStatistics
HTTP bindings

POST /api/v3/noc/application/{application_ids.application_id}/statistics

Method Noc.QueryApplicationEndDevicesActiveMetrics
Request type ApplicationTimeWindowQuery
Response type EndDevicesActiveMetrics
HTTP bindings

POST /api/v3/noc/application/{application_ids.application_id}/end_devices/active-metrics

Method Noc.QueryApplicationGatewaysSeen
Request type ApplicationTimeWindowQuery
Response type ApplicationGatewaysSeen
HTTP bindings

POST /api/v3/noc/application/{application_ids.application_id}/gateways

Method Noc.QueryApplicationChannelsPacketCount
Request type ApplicationTimeBucketQuery
Response type ChannelsPacketCount
HTTP bindings

POST /api/v3/noc/application/{application_ids.application_id}/channels/packet-count

Method Noc.QueryApplicationChannelsUtilization
Request type ApplicationTimeBucketQuery
Response type ChannelsUtilization
HTTP bindings

POST /api/v3/noc/application/{application_ids.application_id}/channels/utilization

Method Noc.QueryApplicationChannelsLoRaPerformance
Request type ApplicationTimeBucketQuery
Response type ChannelsLoRaPerformance
HTTP bindings

POST /api/v3/noc/application/{application_ids.application_id}/channels/lora-performance

Method Noc.QueryApplicationDataRatesPacketCount
Request type ApplicationTimeBucketQuery
Response type DataRatesPacketCount
HTTP bindings

POST /api/v3/noc/application/{application_ids.application_id}/data_rates/packet-count

Method Noc.QueryEndDevicesActive
Request type TimeBucketQuery
Response type ConnectedTimeBuckets
HTTP bindings

POST /api/v3/noc/end_devices/active

Method Noc.QueryEndDevicesActiveMetrics
Request type TimeWindowQuery
Response type EndDevicesActiveMetrics
HTTP bindings

POST /api/v3/noc/end_devices/active-metrics

Method Noc.QueryEndDevicesStatistics
Request type TimeWindowQuery
Response type EndDevicesStatistics
HTTP bindings

POST /api/v3/noc/end_devices/statistics

Method Noc.QueryEndDeviceChannelsPacketCount
Request type EndDeviceTimeBucketQuery
Response type ChannelsPacketCount
HTTP bindings

POST /api/v3/noc/end_device/{end_device_ids.application_ids.application_id}/{end_device_ids.device_id}/channels/packet-count

Method Noc.QueryEndDeviceChannelsUtilization
Request type EndDeviceTimeBucketQuery
Response type ChannelsUtilization
HTTP bindings

POST /api/v3/noc/end_device/{end_device_ids.application_ids.application_id}/{end_device_ids.device_id}/channels/utilization

Method Noc.QueryEndDeviceChannelsLoRaPerformance
Request type EndDeviceTimeBucketQuery
Response type ChannelsLoRaPerformance
HTTP bindings

POST /api/v3/noc/end_device/{end_device_ids.application_ids.application_id}/{end_device_ids.device_id}/channels/lora-performance

Method Noc.QueryEndDeviceDataRatesPacketCount
Request type EndDeviceTimeBucketQuery
Response type DataRatesPacketCount
HTTP bindings

POST /api/v3/noc/end_device/{end_device_ids.application_ids.application_id}/{end_device_ids.device_id}/data_rates/packet-count

Method Noc.QueryEndDevicePacketErrorRate
Request type EndDeviceTimeBucketQuery
Response type PacketErrorRatesTimeBuckets
HTTP bindings

POST /api/v3/noc/end_device/{end_device_ids.application_ids.application_id}/{end_device_ids.device_id}/packet-error-rate

Method Noc.QueryEndDeviceSessionStart
Request type EndDeviceTimeBucketQuery
Response type google.protobuf.Timestamp
HTTP bindings

POST /api/v3/noc/end_device/{end_device_ids.application_ids.application_id}/{end_device_ids.device_id}/session-start

Method Noc.QueryEndDeviceLastSeen
Request type EndDeviceTimeBucketQuery
Response type google.protobuf.Timestamp
HTTP bindings

POST /api/v3/noc/end_device/{end_device_ids.application_ids.application_id}/{end_device_ids.device_id}/last-seen

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

GET /api/v3/noc/configuration

Method Noc.QueryGatewaysActiveMetrics
Request type TimeWindowQuery
Response type GatewaysActiveMetrics
HTTP bindings

POST /api/v3/noc/gateways/active-metrics

Method Noc.QueryGatewaysConnected
Request type TimeBucketQuery
Response type ConnectedTimeBuckets
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.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 ChannelsUtilization
HTTP bindings

POST /api/v3/noc/gateway/{gateway_ids.gateway_id}/channels/utilization

Method Noc.QueryGatewayChannelsLoRaPerformance
Request type GatewayTimeBucketQuery
Response type ChannelsLoRaPerformance
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.QueryGatewayDataRatesPacketCount
Request type GatewayTimeBucketQuery
Response type DataRatesPacketCount
HTTP bindings

POST /api/v3/noc/gateway/{gateway_ids.gateway_id}/data_rates/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 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

required

Field time_window
Type TimeWindowQuery
Description

required

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

required

Field time_bucket
Type TimeBucketQuery
Description

required

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

required

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

required

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

required

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

required

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

required

Field time_bucket
Type TimeBucketQuery
Description

required

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

required

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

defined_only

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 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

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 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

required

Field top
Type uint32
Description

Top number of networks to include.

gte: 1

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

required

Field event_type
Type GatewayConnectionEventType
Description

defined_only

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

required

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

required

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",
  "limit": 0,
  "page": 0,
}

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

Field limit
Type uint32
Description

Limit the number of results per page.

lte: 1000

Field page
Type uint32
Description

Page number for pagination. 0 is interpreted as 1.

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",
  "limit": 0,
  "page": 0,
}

Fields:

Field from
Type google.protobuf. Timestamp
Description

required

Field to
Type google.protobuf. Timestamp
Description

required

Field limit
Type uint32
Description

Limit the number of results per page.

lte: 1000

Field page
Type uint32
Description

Page number for pagination. 0 is interpreted as 1.

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

required

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.
← Join Server APIs Network Server APIs →

On this page

  • The Noc service
  • Messages
  • Enums

Sections

Getting Started

Concepts

The Things Stack Cloud

The Things Stack Enterprise

Integrations

API

Hardware

Sitemap

View our Sitemap

Contributing

GitHub

About Us

The Things Industries