Gateway Server APIs

The Gs service

Method Gs.GetGatewayConnectionStats
Description Get statistics about the current gateway connection to the Gateway Server. This is not persisted between reconnects.
Request type GatewayIdentifiers
Response type GatewayConnectionStats
HTTP bindings

GET /api/v3/gs/gateways/{gateway_id}/connection/stats

Messages

Message GatewayIdentifiers

Field Type Description
gateway_id string

max_len: 36

pattern: ^[a-z0-9](?:[-]?[a-z0-9]){2,}$

eui bytes

Secondary identifier, which can only be used in specific requests.

Show object example
{
  "gateway_id": "",
  "eui": "",
}

Message GatewayConnectionStats

Connection stats as monitored by the Gateway Server.

Field Type Description
connected_at google.protobuf.Timestamp
protocol string

Protocol used to connect (for example, udp, mqtt, grpc)

last_status_received_at google.protobuf.Timestamp
last_status GatewayStatus
last_uplink_received_at google.protobuf.Timestamp
uplink_count uint64
last_downlink_received_at google.protobuf.Timestamp
downlink_count uint64
round_trip_times GatewayConnectionStats.RoundTripTimes
sub_bands repeated GatewayConnectionStats.SubBand

Statistics for each sub band.

Show object example
{
  "connected_at": "0001-01-01T00:00:00Z",
  "protocol": "",
  "last_status_received_at": "0001-01-01T00:00:00Z",
  "last_status": {},
  "last_uplink_received_at": "0001-01-01T00:00:00Z",
  "uplink_count": 0,
  "last_downlink_received_at": "0001-01-01T00:00:00Z",
  "downlink_count": 0,
  "round_trip_times": {},
  "sub_bands": [],
}

Message GatewayConnectionStats.RoundTripTimes

Field Type Description
min google.protobuf.Duration
max google.protobuf.Duration
median google.protobuf.Duration
count uint32
Show object example
{
  "min": "0s",
  "max": "0s",
  "median": "0s",
  "count": 0,
}

Message GatewayStatus

Field Type Description
time google.protobuf.Timestamp

Current time of the gateway

required

boot_time google.protobuf.Timestamp

Boot time of the gateway

  • can be left out to save bandwidth; old value will be kept

versions map of string to string

Versions of gateway subsystems

  • each field can be left out to save bandwidth; old value will be kept
  • map keys are written in snake_case
  • for example: firmware: “2.0.4” forwarder: “v2-3.3.1” fpga: “48” dsp: “27” hal: “v2-3.5.0”

antenna_locations repeated Location

Location of each gateway’s antenna

  • if left out, server uses registry-set location as fallback

ip repeated string

IP addresses of this gateway. Repeated addresses can be used to communicate addresses of multiple interfaces (LAN, Public IP, …).

metrics map of string to float

Metrics

  • can be used for forwarding gateway metrics such as temperatures or performance metrics
  • map keys are written in snake_case

advanced google.protobuf.Struct

Advanced metadata fields

  • can be used for advanced information or experimental features that are not yet formally defined in the API
  • field names are written in snake_case

Show object example
{
  "time": "0001-01-01T00:00:00Z",
  "boot_time": "0001-01-01T00:00:00Z",
  "versions": {},
  "antenna_locations": [],
  "ip": [],
  "metrics": {},
  "advanced": {},
}