AT&T · Schema

NetworkMetrics

NetworkMetrics schema

5GBroadbandCAMARAConnectivityDevice StatusEdge ComputingEnterpriseFortune 100MessagingMobileNetworkNetwork APIsSIM SwapSpeechTelecommunicationsWirelessWireline

Properties

Name Type Description
networkGeneration string Current network generation for the device
signalStrength string Signal quality indicator
estimatedDownlinkThroughput integer Estimated downlink throughput in Mbps
estimatedUplinkThroughput integer Estimated uplink throughput in Mbps
estimatedLatency integer Estimated round-trip latency in milliseconds
congestionLevel string Current network congestion level
View JSON Schema on GitHub

JSON Schema

network-insights-api-network-metrics-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/att/refs/heads/main/json-schema/network-insights-api-network-metrics-schema.json",
  "title": "NetworkMetrics",
  "description": "NetworkMetrics schema",
  "type": "object",
  "properties": {
    "networkGeneration": {
      "type": "string",
      "description": "Current network generation for the device",
      "enum": [
        "5G",
        "5G_NSA",
        "4G",
        "3G"
      ],
      "example": "5G"
    },
    "signalStrength": {
      "type": "string",
      "description": "Signal quality indicator",
      "enum": [
        "EXCELLENT",
        "GOOD",
        "FAIR",
        "POOR"
      ],
      "example": "GOOD"
    },
    "estimatedDownlinkThroughput": {
      "type": "integer",
      "description": "Estimated downlink throughput in Mbps",
      "example": 250
    },
    "estimatedUplinkThroughput": {
      "type": "integer",
      "description": "Estimated uplink throughput in Mbps",
      "example": 50
    },
    "estimatedLatency": {
      "type": "integer",
      "description": "Estimated round-trip latency in milliseconds",
      "example": 15
    },
    "congestionLevel": {
      "type": "string",
      "description": "Current network congestion level",
      "enum": [
        "LOW",
        "MEDIUM",
        "HIGH"
      ],
      "example": "LOW"
    }
  }
}