Zum Inhalt

Offene Insight-APIs

Einführung

Sie können auf Ihrer Analyzer-Instanz offene APIs installieren, mit denen sich Echtzeitmessungen und Leistungskennzahlen (KPIs) zu Latenz, Durchsatz und Zuverlässigkeit abrufen lassen.

Die APIs können ausgewählte Daten abrufen, die in den vorhandenen visuellen Dashboards verfügbar sind, etwa die Latenzmessung pro Protokoll, aggregierte KPIs für Netz- und Anwendungslatenz sowie neue Netzqualitätsmerkmale wie Volatilität und Stabilität.

Die Ausgabedaten der API werden für ein bestimmtes QoSAgent-Reflector-Paar im JSON-Format bereitgestellt. Das Ergebnis lässt sich anschließend einfach in andere externe Systeme integrieren.

Mit der API A) Connectivity Insight können Benutzer die Analyzer-Instanz anhand der AgentID nach Konnektivitäts-Leistungsdaten eines bestimmten QoSAgent abfragen.

Mit der API B) Throughput Insight können Benutzer die Analyzer-Instanz nach Echtzeit-Durchsatzmessungen über das Lifbe-Protokoll abfragen (sofern konfiguriert und aktiviert). Die Download- und Upload-Ergebnisse in Mbps sowie die zugehörigen Jitter-Ergebnisse werden über diese API abgerufen.

Die API C) Latency Insight dient zum Abrufen der Latenzmessungen für ein bestimmtes Protokoll und einen bestimmten Agent innerhalb eines vom Benutzer in Sekunden festgelegten Zeitraums.

Die API D) Geoloc Insight dient zum Abfragen der zuletzt gemessenen durchschnittlichen Latenz und ihrer geografischen Koordinaten im GPS-Format (sofern verfügbar und konfiguriert). Mit dem optionalen Abfrageparameter time_range am Endpunkt /api/v1/geoloc können Benutzer den Zeitraum in Sekunden angeben, für den sie historische Geolokalisierungsdaten abrufen möchten.

Mit der API E) Twamp Insight lassen sich die zuletzt mit dem Protokoll TWAMP (RFC 5357) gemessenen detaillierten Latenzwerte für einen bestimmten QoSAgent abfragen. Die Latenzergebnisse sind aufgeteilt in Hinweglatenz in ms, Rückweglatenz in ms und Verarbeitungslatenz in ms (d. h. die im Reflector verbrachte Zeit).

Die API F) Forecast Insight liefert die neuesten prognostizierten Messwerte auf Basis eines statistischen Mittelwerts und einer Projektion.

Die API G) Radio Insight liefert die neuesten Funk-/Mobilfunkmesswerte.

Die API H) Networks liefert alle customer_id / Netze im Analyzer.

Die API I) Agents liefert alle QoS-Agents, die einer customer_id zugeordnet sind, entweder nur mit ID oder zusätzlich mit Metadaten.

Die API J) Anomalies Insight erkennt und meldet Netzwerkanomalien über alle Protokolle mit detaillierten Anomaliemetriken und Musteranalyse.

Die API K) Performance Trends analysiert die Leistungstrends der Agents im Zeitverlauf und vergleicht die aktuelle Leistung mit historischen Referenzwerten, um Verschlechterungsmuster zu erkennen.

Die API L) Health Report erstellt umfassende Berichte zum Netzzustand mit Agent-Ranglisten, Leistungsverteilung und umsetzbaren Empfehlungen.

Die API M) Agent Rankings ordnet alle Agents nach Leistungsmetriken und Trends und identifiziert die leistungsstärksten und -schwächsten Agents in Ihrem Netz.

Die API N) Correlation Analysis erkennt Korrelationsmuster zwischen Agents, um netzweite Probleme zu identifizieren, die mehrere Standorte gleichzeitig betreffen.

Die API O) Degradation Alerts identifiziert proaktiv Agents, deren Leistung sich über konfigurierbare Schwellenwerte hinaus und über festgelegte Zeiträume verschlechtert.

Die API P) iPerf Throughput Insight liefert den TCP- und UDP-Durchsatz der iPerf-Messungen für einen bestimmten QoSAgent.

Für die API müssen Sie auf Ihrer Analyzer-Instanz Port 12099 öffnen und absichern.

Verwendung

Authentifizierung

Die API verwendet die Authentifizierung per API-Schlüssel. Fügen Sie Ihren API-Schlüssel bei jeder Anfrage in den Header x-api-key ein:

x-api-key: your_api_key_here

Den API-Schlüssel finden Sie in den Protokollen des Containers:

docker logs <api_container_ID>| grep "API Key:"

A) API Connectivity Insight

Die Ergebnisse verwenden gemischte Zeitfenster: 10 Sekunden für die Latenz pro Protokoll, 5 Minuten für Jitter/Volatilität/Stabilität, 30 Sekunden für die QoE, 12 Stunden für den Durchsatz und 1 Woche für Metadaten und erwartete Werte.

Wird mit dem Endpunkt /api/v1/ci verwendet. Die Messwerte der Agents erhalten Sie mit den Parametern agent_id und customer_id:

curl -H "x-api-key: your_api_key_here" -s -k https://<analyzer_IP>:12099/api/v1/ci?agent_id=<agentID>&customer_id=<customerID>

Beispielausgabe:

{
    "CustomerID": "0",
    "agentID": "0",
    "KPIs": {
        "tcpMs": 8.94,
        "udpMs": 9.53,
        "httpMs": 9.09,
        "httpsMs": 18,
        "icmpMs": 9.2,
        "twampMs": 9.45,
        "downloadThroughputMbps": 1383.58,
        "uploadThroughputMbps": 950.06,
        "networkLatencyMs": 9.32,
        "applicationLatencyMs": 11.39,
        "packetLossRatePercent": 0,
        "jitterMs": 6.1,
        "volatilityPercent": 46.2,
        "networkStabilityPercent": 65.5,
        "connectivityHealth": "Warning",
        "qualityOfExperience": 4.921,
        "expectedLatencyMS": 40,
        "expectedStabilityPercent": 98,
        "expectedPacketLossPercent": 0.1
    },
    "Attributes": {
        "time": "2025-03-26T14:01:23.305Z",
        "agentName": "GenericQoSAgent",
        "hardware": "Not-Applicable",
        "networkName": "OutScale-Network",
        "networkType": "Outscale",
        "gpsPos": "48.864716,2.349014",
        "details": "Generic QoSAgent preinstalled with OMI",
    },
    "APInotes": {
        "comment": "Results from LatenceTech ConnectivityInsight API version 2.1",
        "documentation": "Refer to docs.latence.ca for API details and data structure"
    }
}

Neue Konnektivitätsinformationen v2

GET /v2/ci?customer_id={customer_id}&agent_id={agent_id}

Der Endpunkt v2 liefert weder die erwarteten Werte noch volatilityPercent, networkStabilityPercent, connectivityHealth oder die Metadaten.

Er wurde als schlanke Version von /v1/ci konzipiert.

B) API Throughput Insight

Liefert die neuesten LIFBE-Werte der letzten 2 Stunden für Durchsatz und Jitter und der letzten 12 Stunden für den Paketverlust.

Wird mit dem Endpunkt /api/v1/lifbe verwendet. Die Echtzeitdaten der Durchsatzmessungen über das Lifbe-Protokoll erhalten Sie mit den Parametern agent_id und customer_id:

curl -H "x-api-key: your_api_key_here" -s -k https://<analyzer_IP>:12099/api/v1/lifbe?agent_id=<agentID>&customer_id=<customerID>

Beispielausgabe:

{
    "agentID": "1",
    "time": "2024-05-17T15:00:04.735Z",
    "lifbeDownload": 542.48,
    "lifbeUpload": 49.89,
    "jitterDownload": 1.23,
    "jitterUpload": 3.13,
    "networkInterface": "MOBILE",
    "networkType": "MOBILE_5G"
}

C) API Latency Insight

Erfordert time_range (Sekunden) oder chosen_time; es gibt kein Standardzeitfenster.

Wird mit dem Endpunkt /api/v1/latency verwendet. Die Messwerte für ein bestimmtes Protokoll und einen bestimmten Agent innerhalb eines benutzerdefinierten Zeitraums erhalten Sie, indem Sie der Anfrage zusätzlich zu den Parametern agent_id und customer_id 3 optionale Argumente hinzufügen: 1) protocol (tcp, udp, https, httpss, icmp, twamp) 2) time_range (in Sekunden) 3) chosen_time

curl -H "x-api-key: your_api_key_here" -s -k https://<analyzer_IP>:12099/api/v1/latency?agent_id=<agentID>&customer_id=<customerID>&protocol=tcp&time_range=400

Beispielausgabe:

[   
    {
        "agentID": "1",
        "time": "2024-05-17T15:01:26.183Z",
        "measurement": "tcp_result",
        "value": 15.61
    },
    {
        "agentID": "1",
        "time": "2024-05-17T15:01:28.215Z",
        "measurement": "tcp_result",
        "value": 15.233
    }
]

Optional: Der Parameter protocol ist optional; ist er nicht gesetzt, werden alle Protokolle angezeigt.

Optional: Mit dem Parameter chosen_time können Sie Daten für einen bestimmten Zeitraum abfragen, im Format start_time,end_time (z. B.: 2025-05-30T10:00:00Z,2025-06-15T17:00:00Z). Nicht zusammen mit time_range verwenden.

Die angegebene Zeit muss in UTC oder in der für den Analyzer konfigurierten Zeitzone angegeben werden (standardmäßig UTC)

curl -H "x-api-key: your_api_key_here" -s -k https://<analyzer_IP>:12099/api/v1/latency?customer_id=<customerID>&agent_id=<agentID&chosen_time=2025-07-07T16:12:26Z,2025-07-07T16:12:34Z

Beispielausgabe:

[
  {
    "CustomerID": "0",
    "agentID": "9",
    "time": "2025-07-07T16:12:25.000Z",
    "tcp": 46.364,
    "udp": 48.355,
    "http": 49.572,
    "https": 96.752,
    "twamp": 47.791,
    "icmp": 48.5
  },
  {
    "CustomerID": "0",
    "agentID": "9",
    "time": "2025-07-07T16:12:30.000Z",
    "tcp": 48.233,
    "udp": 48.005,
    "http": 47.985,
    "https": 96.531,
    "twamp": 47.812,
    "icmp": 48.5
  }
]

D) API Geoloc Insight

Verwendet standardmäßig die letzte Minute oder den durch time_range (Sekunden) festgelegten Zeitraum.

Sie können die mobile App (oder ein Modem/CPE mit aktivierter Geolokalisierung) verwenden und GPS-Daten an den Analyzer senden; dann können Sie den aktuellen Latenzstatus sowie historische Daten mit dem vorherigen Standort einsehen.

Wird mit dem Endpunkt /api/v1/geoloc verwendet. Sie können die Parameter agent_id und customer_id sowie optional time_range (in Sekunden) angeben, um historische Daten zu erhalten:

curl -H "x-api-key: your_api_key_here" -s -k https://<analyzer_IP>:12099/api/v1/geoloc?agent_id=<agentID>&customer_id=<customerID>

Für historische Daten:

curl -H "x-api-key: your_api_key_here" -s -k https://<analyzer_IP>:12099/api/v1/geoloc?agent_id=<agentID>&customer_id=<customerID>&time_range=400

Beispielausgabe:

{
    "agentID": "50",
    "time": "2024-05-17T15:01:20Z",
    "altitude": "39.1",
    "latitude": "45.4961001",
    "longitude": "-73.5619866",
    "applicationLatency": 10.213
}

E) API Twamp Insight

Liefert die neuesten TWAMP-Deltas der letzten 5 Minuten.

Mit dieser API lassen sich die zuletzt mit dem Protokoll TWAMP (RFC 5357) gemessenen detaillierten Latenzwerte für einen bestimmten QoSAgent abfragen. Die Latenzergebnisse sind: - TwampFwdDeltaMs = TWAMP-Hinweg-Delta (d. h. Latenz zwischen QoSAgent -> Reflector) in Millisekunden - TwampRevDeltaMs = TWAMP-Rückweg-Delta (d. h. Latenz zwischen Reflector -> QoSAgent) in Millisekunden - TwampProcDeltaMs = TWAMP-Verarbeitungs-Delta (d. h. im Reflector entstehende Latenz) in Millisekunden

Wird mit dem Endpunkt /api/v1/twamp verwendet. Sie können die Parameter agent_id und customer_id angeben:

curl -H "x-api-key: your_api_key_here" -s -k https://<analyzer_IP>:12099/api/v1/twamp?agent_id=<agentID>&customer_id=<customerID>

Beispielausgabe:

{
    "agentID": "12",
    "time": "2024-06-21T18:56:58.512Z",
    "TwampFwdDeltaMs":  0.32,
    "TwampRevDeltaMs":  0.94,
    "TwampProcDeltaMs": 0.18,
}

F) API Forecast Insight

Die projizierte Latenz verwendet die letzten 5 Minuten; Prognoseintervall und Konfidenzniveau werden über die letzten 10 Minuten an Latenzdaten berechnet.

Diese API liefert die neuesten prognostizierten Messwerte auf Basis eines statistischen Mittelwerts und einer Projektion.

Wird mit dem Endpunkt /api/v1/forecast verwendet. Sie können die Parameter agent_id und customer_id angeben:

curl -H "x-api-key: your_api_key_here" -s -k https://<analyzer_IP>:12099/api/v1/forecast?agent_id=<agentID>&customer_id=<customerID>

Beispielausgabe:

{
    "agentID": "1",
    "time": "2024-06-21T18:56:58.512Z",
    "projectedLatencyMs": 1.5,
    "forecastingIntervalMs": 3.28,
    "confidenceLevel": 0
}

G) API Radio Insight

Die neueste Momentaufnahme verwendet die letzten 10 Sekunden; mit time_range oder chosen_time werden die Daten für dieses benutzerdefinierte Zeitfenster zurückgegeben.

Diese API liefert die neuesten Funk-/Mobilfunkmesswerte.

Wird mit dem Endpunkt /api/v1/radio verwendet. Sie können die Parameter agent_id und customer_id angeben:

curl -H "x-api-key: your_api_key_here" -s -k https://<analyzer_IP>:12099/api/v1/radio?agent_id=<agentID>&customer_id=<customerID>

Beispielausgabe:

{
    "CustomerID": "0",
    "agentID": "1",
    "time": "2025-02-04T17:12:56.062Z",
    "networkName": "Bell",
    "networkType": "4G LTE",
    "cellID": "40",
    "SINR_dB": "2.147489",
    "RSSI_dBm": "-63",
    "RSRP_dBm": "-10",
    "RSRQ_dB": "-94"
}

Optional: Mit dem Parameter chosen_time können Sie Daten für einen bestimmten Zeitraum abfragen, im Format start_time,end_time (z. B.: 2025-05-30T10:00:00Z,2025-06-15T17:00:00Z) Die angegebene Zeit muss in UTC oder in der für den Analyzer konfigurierten Zeitzone angegeben werden (standardmäßig UTC)

curl -H "x-api-key: your_api_key_here" -k https://<analyzer_IP>:12099/api/v1/radio?customer_id=<customerID>&agent_id=<agentID&chosen_time=2025-07-07T16:12:26Z,2025-07-07T16:12:34Z

Beispielausgabe:

[
  {
    "CustomerID": "0",
    "agentID": "12",
    "time": "2025-07-08T15:21:07.94Z",
    "ECIO_dB": "0",
    "PCI": "908",
    "RSRP_dBm": "-101",
    "RSRQ_dB": "-13",
    "RSSI_dBm": "0",
    "SINR_dB": "15.5",
    "cellID": "22938075680",
    "networkName": "TELUS",
    "networkType": "5G"
  },
  {
    "CustomerID": "0",
    "agentID": "12",
    "time": "2025-07-08T15:21:17.932Z",
    "ECIO_dB": "0",
    "PCI": "908",
    "RSRP_dBm": "-101",
    "RSRQ_dB": "-13",
    "RSSI_dBm": "0",
    "SINR_dB": "16",
    "cellID": "22938075680",
    "networkName": "TELUS",
    "networkType": "5G"
  },
]

H) API Networks

Listet die in der letzten Stunde gesehenen Customer IDs auf.

Diese API liefert die customer_id des Analyzer.

Wird mit dem Endpunkt /api/v1/networks verwendet. Es sind keine Parameter erforderlich

curl -H "x-api-key: your_api_key_here" -s -k https://<analyzer_IP>:12099/api/v1/networks

Beispielausgabe:

{
  "count": 1,
  "customerId": [
    "0"
  ]
}

I) API Agents

Listet die in den letzten 20 Sekunden aktiven Agents auf; die Metadaten (falls angefordert) stammen aus der letzten Woche.

Diese API liefert die Agents einer customer_id des Analyzer.

Wird mit dem Endpunkt /api/v1/agents verwendet. Sie können den Parameter customer_id und optional metadata=true angeben, um zusätzlich die Metadaten jedes Agents zu erhalten:

curl -H "x-api-key: your_api_key_here" -s -k https://<analyzer_IP>:12099/api/v1/agents?customer_id=<customer_id>&metadata=true

Beispielausgabe:

{
  "CustomerID": "0",
  "count": 1,
  "agents": [
    {
      "id": "9",
      "name": "Montreal ref",
      "networkName": "AzNet",
      "networkType": "Azure Server Network",
      "hardware": "Azure Server",
      "details": "Azure Agent uses for Testing plateform",
      "gpsPosition": "-43.8121,78.3522"
    }
  ]
}

J) API Anomalies Insight

Erfordert time_range oder chosen_time; die Latenz wird in Zeitfenstern von 30 Sekunden aggregiert.

Diese API erkennt und meldet Netzwerkanomalien über alle Protokolle mit detaillierten Metriken, darunter der Anomalie-MAD (mittlere absolute Abweichung vom Median), Paketverluste, Latenzspitzen und Muster der Anomalieverteilung.

Wird mit dem Endpunkt /api/v1/anomalies verwendet. Sie können die Parameter agent_id, customer_id, optional protocol (tcp, udp, http, https, icmp, twamp) und time_range (in Sekunden) angeben:

curl -H "x-api-key: your_api_key_here" -k -s "https://<analyzer_IP>:12099/api/v1/anomalies?agent_id=<agentID>&customer_id=<customerID>&protocol=tcp&time_range=3600"

Beispielausgabe:

{
    "CustomerID": "0",
    "agentID": "1",
    "time": "2025-01-15T14:30:45.123Z",
    "tcp": {
        "anomaly_mad": 15.2,
        "drops": 3,
        "latency": 45.6,
        "anomaly_distribution": 8.9
    },
    "anomaliesDetected": true,
    "summary": "Das TCP-Protokoll zeigt erhöhte Anomalieindikatoren"
}

Vergleicht die durchschnittliche Latenz der letzten Stunde mit einem Referenzwert über die vorherigen N Tage (standardmäßig 7, bis gestern).

Diese API analysiert die Leistungstrends der Agents im Zeitverlauf und vergleicht die aktuelle Leistung mit historischen Referenzwerten, um Verschlechterungsmuster und den Leistungsstatus zu erkennen.

Wird mit dem Endpunkt /api/v1/trends verwendet. Sie können die Parameter agent_id, customer_id und optional lookback_days angeben:

curl -H "x-api-key: your_api_key_here" -k -s "https://<analyzer_IP>:12099/api/v1/trends?agent_id=<agentID>&customer_id=<customerID>&lookback_days=7"

Beispielausgabe:

{
    "CustomerID": "0",
    "agentID": "1",
    "time": "2025-01-15T14:30:45.123Z",
    "currentLatency": 42.5,
    "baselineLatency": 35.2,
    "trendPercentage": 20.7,
    "status": "DEGRADED",
    "lookbackDays": 7
}

L) API Health Report

Aggregiert die durchschnittliche Latenz über den Berichtszeitraum: 1 Tag (daily), 7 Tage (weekly) oder 30 Tage (monthly).

Diese API erstellt umfassende Berichte zum Netzzustand mit der Leistungsverteilung der Agents, Ranglisten und umsetzbaren Empfehlungen zur Netzoptimierung.

Wird mit dem Endpunkt /api/v1/health-report verwendet. Sie können die Parameter customer_id, optional report_period (daily, weekly, monthly) und include_recommendations (true/false) angeben:

curl -H "x-api-key: your_api_key_here" -k -s "https://<analyzer_IP>:12099/api/v1/health-report?customer_id=<customerID>&report_period=daily&include_recommendations=true"

Beispielausgabe:

{
    "CustomerID": "0",
    "reportPeriod": "daily",
    "generatedAt": "2025-01-15T14:30:45.123Z",
    "summary": {
        "totalAgents": 5,
        "healthDistribution": {
            "good": 3,
            "fair": 1,
            "poor": 1
        },
        "overallScore": 76.0
    },
    "agentDetails": [
        {
            "agentID": "1",
            "avgLatency": 25.3,
            "status": "GOOD"
        },
        {
            "agentID": "2", 
            "avgLatency": 65.8,
            "status": "FAIR"
        },
        {
            "agentID": "3",
            "avgLatency": 120.4,
            "status": "POOR"
        }
    ],
    "recommendations": [
        "Insgesamt 5 Agents überwacht",
        "3 Agents arbeiten gut", 
        "1 Agents erfordern Aufmerksamkeit",
        "1 Agents erfordern eine sofortige Untersuchung",
        "Priorität: Agents mit Status POOR untersuchen"
    ]
}

M) API Agent Rankings

Ordnet die Agents nach der durchschnittlichen Latenz über time_range Sekunden (standardmäßig 24 Stunden).

Diese API ordnet alle Agents nach Leistungsmetriken und Trends und identifiziert die leistungsstärksten und -schwächsten Agents mit detaillierten Leistungswerten und einer vergleichenden Analyse.

Wird mit dem Endpunkt /api/v1/agent-rankings verwendet. Sie können die Parameter customer_id, optional metric (latency, stability, connectivity_health, overall) und time_range (in Sekunden) angeben:

curl -H "x-api-key: your_api_key_here" -k -s "https://<analyzer_IP>:12099/api/v1/agent-rankings?customer_id=<customerID>&metric=overall&time_range=86400"

Beispielausgabe:

{
    "CustomerID": "0",
    "metric": "overall",
    "timeRangeSeconds": 86400,
    "generatedAt": "2025-01-15T14:30:45.123Z",
    "totalAgents": 5,
    "rankings": [
        {
            "agentID": "1",
            "avgLatency": 22.4,
            "performanceScore": 77.6,
            "rank": 1
        },
        {
            "agentID": "3",
            "avgLatency": 45.2,
            "performanceScore": 54.8,
            "rank": 2
        },
        {
            "agentID": "2",
            "avgLatency": 85.7,
            "performanceScore": 14.3,
            "rank": 3
        }
    ],
    "topPerformer": {
        "agentID": "1",
        "avgLatency": 22.4,
        "performanceScore": 77.6,
        "rank": 1
    },
    "bottomPerformer": {
        "agentID": "2",
        "avgLatency": 85.7,
        "performanceScore": 14.3,
        "rank": 3
    }
}

N) API Correlation Analysis

Analysiert die Latenz über time_range Sekunden (standardmäßig 2 Stunden), aggregiert in Zeitfenstern von 5 Minuten.

Diese API erkennt Korrelationsmuster zwischen Agents, um netzweite Probleme zu identifizieren, die mehrere Standorte betreffen, mit statistischer Korrelationsanalyse und Musterklassifizierung.

Wird mit dem Endpunkt /api/v1/correlation-analysis verwendet. Sie können die Parameter customer_id, optional correlation_threshold (0.0-1.0) und time_range (in Sekunden) angeben:

curl -H "x-api-key: your_api_key_here" -k -s "https://<analyzer_IP>:12099/api/v1/correlation-analysis?customer_id=<customerID>&correlation_threshold=0.7&time_range=7200"

Beispielausgabe:

{
    "CustomerID": "0",
    "time": "2025-01-15T14:30:45.123Z",
    "correlationThreshold": 0.7,
    "timeRangeSeconds": 7200,
    "totalAgentsAnalyzed": 4,
    "patternsFound": 2,
    "patterns": [
        {
            "description": "Agents mit ähnlichen Mustern der Latenzverschlechterung",
            "affectedAgents": ["1", "2", "4"],
            "correlationStrength": 0.85,
            "patternType": "similar_degradation",
            "severity": "MEDIUM", 
            "recommendation": "Gemeinsame Netzinfrastruktur untersuchen – mehrere Agents ähnlich betroffen"
        },
        {
            "description": "Agents mit gegenläufigen Latenzmustern",
            "affectedAgents": ["3", "5"],
            "correlationStrength": 0.72,
            "patternType": "inverse_pattern", 
            "severity": "LOW",
            "recommendation": "Verhalten von Lastverteilung oder Failover prüfen, das verschiedene Agents betrifft"
        }
    ]
}

O) API Degradation Alerts

Vergleicht die durchschnittliche Latenz der letzten Stunde mit einem Referenzwert über lookback_days Tage (standardmäßig 3, bis gestern).

Diese API identifiziert proaktiv Agents, deren Leistung sich über konfigurierbare Schwellenwerte hinaus verschlechtert, mit Schweregradklassifizierung und detaillierter Analyse der Verschlechterung.

Wird mit dem Endpunkt /api/v1/degradation-alerts verwendet. Sie können die Parameter customer_id, optional severity_threshold (Prozent) und lookback_days angeben:

curl -H "x-api-key: your_api_key_here" -k -s "https://<analyzer_IP>:12099/api/v1/degradation-alerts?customer_id=<customerID>&severity_threshold=20&lookback_days=3"

Beispielausgabe:

{
    "CustomerID": "0",
    "time": "2025-01-15T14:30:45.123Z",
    "alertCount": 2,
    "severityThreshold": 20,
    "daysLookback": 3,
    "alerts": [
        {
            "agentID": "3",
            "degradationPercent": 45.2,
            "currentLatency": 78.5,
            "baselineLatency": 54.1,
            "severity": "HIGH",
            "message": "Agent 3 zeigt über 3 Tage eine Leistungsverschlechterung von 45,2 %"
        },
        {
            "agentID": "2", 
            "degradationPercent": 22.8,
            "currentLatency": 55.3,
            "baselineLatency": 45.0,
            "severity": "MEDIUM",
            "message": "Agent 2 zeigt über 3 Tage eine Leistungsverschlechterung von 22,8 %"
        }
    ]
}

P) API iPerf Throughput Insight

Liefert den neuesten iPerf-Durchsatz für TCP und UDP der letzten 12 Stunden.

Diese API liefert den TCP- und UDP-Durchsatz aus den iPerf-Messungen für einen bestimmten QoSAgent.

Wird mit dem Endpunkt /api/v1/iperf verwendet. Sie können die Parameter agent_id und customer_id angeben:

curl -H "x-api-key: your_api_key_here" -s -k https://<analyzer_IP>:12099/api/v1/iperf?agent_id=<agentID>&customer_id=<customerID>

Beispielausgabe:

{
    "CustomerID": "0",
    "agentID": "1",
    "time": "2026-06-15T14:59:46.207Z",
    "tcp": {
        "downloadThroughputMbps": 380.38,
        "uploadThroughputMbps": 246.02
    },
    "udp": {
        "downloadThroughputMbps": 120.5,
        "uploadThroughputMbps": 98.3
    }
}

API-Definition

Eine API-Definitionsdatei nach dem OpenAPI-Standard ist im YAML-Format verfügbar. Sie können die Datei hier herunterladen:

wget https://api.latence.ca/software/latencetech_api_definition.yml

Fehlerbehebung

customerID is required oder agentID is required.

Je nach verwendeter Umgebung muss der Analyzer-Teil der Anfrage möglicherweise in Anführungszeichen gesetzt werden:

curl -H "x-api-key: your_api_key_here" -s -k "https://<analyzer_IP>:12099/api/v1/ci?agent_id=<agentID>&customer_id=<customerID>"