Aller au contenu

API Ouvertes Insight

Introduction

Vous pouvez installer des API ouvertes sur votre instance d'Analyzer permettant l'extraction de mesures en temps réel et d'indicateurs clés de performance (KPI) liés à la latence, au débit et à la fiabilité.

Les API peuvent extraire des données sélectionnées disponibles dans les tableaux de bord visuels existants tels que la mesure de latence par protocole, les KPI agrégés pour les niveaux de latence réseau et applicative et de nouveaux qualificatifs de qualité réseau tels que la volatilité et la stabilité.

Les données de sortie de l'API sont présentées au format JSON pour une paire QoSAgent-Reflector donnée. Le résultat peut ensuite être facilement intégré dans d'autres systèmes externes.

L'API A) Connectivity Insight permet aux utilisateurs d'interroger l'instance d'Analyzer pour obtenir des données de performance de connectivité concernant un QoSAgent spécifique en utilisant son AgentID.

L'API B) Throughput Insight permet aux utilisateurs d'interroger l'instance d'Analyzer pour obtenir des mesures de débit en temps réel en utilisant le protocole Lifbe (lorsqu'il est configuré et activé). Les résultats de téléchargement et de téléversement en Mbps et les résultats de gigue associés sont récupérés à l'aide de cette API.

L'API C) Latency Insight peut être utilisée pour récupérer les mesures de latence pour un protocole spécifique et pour un agent spécifique dans une plage de temps déterminée par l'utilisateur définie en secondes.

L'API D) Geoloc Insight est utilisée pour interroger la dernière latence moyenne mesurée et ses coordonnées géographiques au format GPS (lorsque disponibles et configurées). L'ajout du paramètre de requête optionnel time_range au point de terminaison /api/v1/geoloc permet aux utilisateurs de spécifier la période en secondes pour laquelle ils souhaitent récupérer les données de géolocalisation historiques.

L'API E) Twamp Insight peut être utilisée pour interroger les derniers niveaux de latence détaillés mesurés en utilisant le protocole TWAMP (RFC 5357) pour un QoSAgent donné. Les résultats de latence sont divisés entre la latence directe en ms, la latence de retour en ms et la latence de traitement en ms (c'est-à-dire le temps passé dans le Reflector).

L'API F) Forecast Insight fournit les dernières mesures prévues en utilisant une moyenne statistique et une projection.

L'API G) Radio Insight fournit les dernières mesures radio/cellulaires.

L'API H) Networks fournit tous les customer_id / réseaux sur l'Analyzer.

L'API I) Agents fournit tous les QoS-Agents rattachés à un customer_id, peut inclure soit uniquement l'ID, soit également les métadonnées.

L'API J) Anomalies Insight détecte et signale les anomalies réseau sur tous les protocoles avec des métriques d'anomalie détaillées et une analyse des modèles.

L'API K) Performance Trends analyse les tendances de performance des agents au fil du temps, en comparant les performances actuelles aux références historiques pour identifier les modèles de dégradation.

L'API L) Health Report génère des rapports complets sur la santé du réseau avec des classements d'agents, une distribution des performances et des recommandations exploitables.

L'API M) Agent Rankings classe tous les agents selon les métriques de performance et les tendances, en identifiant les meilleurs et les moins bons performeurs sur votre réseau.

L'API N) Correlation Analysis détecte les modèles de corrélation entre les agents pour identifier les problèmes à l'échelle du réseau affectant plusieurs emplacements simultanément.

L'API O) Degradation Alerts identifie de manière proactive les agents présentant une dégradation des performances au-dessus de seuils configurables sur des périodes spécifiées.

L'API P) iPerf Throughput Insight retourne le débit TCP et UDP des mesures iPerf pour un QoSAgent donné.

L'API nécessite que vous ouvriez et sécurisiez le port 12099 sur votre instance d'Analyzer.

Utilisation

Authentification

L'API utilise l'authentification par clé API. Incluez votre clé API dans l'en-tête x-api-key avec chaque requête :

x-api-key: your_api_key_here

Vous pouvez récupérer la clé API en examinant les journaux du conteneur :

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

A) API Connectivity Insight

Les résultats utilisent des fenêtres mixtes : 10 secondes pour la latence par protocole, 5 minutes pour la gigue/volatilité/stabilité, 30 secondes pour la QoE, 12 heures pour le débit, et 1 semaine pour les métadonnées et valeurs attendues.

Utilisée avec le point de terminaison /api/v1/ci. Vous pouvez voir les mesures pour les agents en utilisant les paramètres agent_id et 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>

exemple de sortie :

{
    "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"
    }
}

Nouvelles informations de connectivité v2

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

Le point de terminaison v2 ne fournit pas les valeurs attendues, le volatilityPercent, le networkStabilityPercent, le connectivityHealth, ainsi que les métadonnées.

Cela a été conçu pour être une version allégée du /v1/ci.

B) API Throughput Insight

Retourne les dernières valeurs LIFBE des 2 dernières heures pour le débit et la gigue, et des 12 dernières heures pour la perte de paquets.

Utilisée avec le point de terminaison /api/v1/lifbe. Vous pouvez afficher les données en temps réel des mesures de débit en utilisant le protocole Lifbe avec les paramètres agent_id et 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>

exemple de sortie :

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

Nécessite time_range (secondes) ou chosen_time ; il n'y a pas de fenêtre par défaut.

Utilisée avec le point de terminaison /api/v1/latency. Vous pouvez voir les mesures pour un protocole spécifique pour un agent spécifique dans une plage de temps déterminée par l'utilisateur en ajoutant 3 arguments optionnels à la requête en plus des paramètres agent_id et customer_id : 1) protocol (tcp, udp, https, httpss, icmp, twamp) 2) time_range (en secondes) 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

exemple de sortie :

[   
    {
        "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
    }
]

Optionnel : le paramètre protocol est optionnel, s'il n'est pas défini, tous les protocoles seront affichés.

Optionnel : l'utilisation du paramètre chosen_time vous permet d'interroger les données pour une période donnée, format start_time,end_time (ex : 2025-05-30T10:00:00Z,2025-06-15T17:00:00Z). À ne pas utiliser avec time_range.

L'heure spécifiée doit être en UTC, ou le fuseau horaire configuré pour l'Analyzer (UTC par défaut)

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

exemple de sortie :

[
  {
    "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

Utilise la dernière minute par défaut, ou la période définie par time_range (secondes).

Vous pouvez utiliser l'application mobile (ou un modem/CPE avec récupération de géolocalisation activée) et envoyer des données GPS à l'Analyzer, vous pourrez vérifier l'état actuel de la latence ainsi que les données historiques avec l'emplacement précédent.

Utilisée avec le point de terminaison /api/v1/geoloc. Vous pouvez ajouter les paramètres agent_id et customer_id et un time_range optionnel (en secondes) pour obtenir les données historiques :

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

Pour les données historiques :

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

exemple de sortie :

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

E) API Twamp Insight

Retourne les derniers deltas TWAMP des 5 dernières minutes.

Cette API peut être utilisée pour interroger les derniers niveaux de latence détaillés mesurés en utilisant le protocole TWAMP (RFC 5357) pour un QoSAgent donné. Les résultats de latence sont les suivants : - TwampFwdDeltaMs = Delta direct TWAMP (c'est-à-dire latence entre QoSAgent -> Reflector) en millisecondes - TwampRevDeltaMs = Delta de retour TWAMP (c'est-à-dire latence entre Reflector -> QoSAgent) en millisecondes - TwampProcDeltaMs = Delta de traitement TWAMP (c'est-à-dire latence se produisant dans le Reflector) en millisecondes

Utilisée avec le point de terminaison /api/v1/twamp. Vous pouvez ajouter les paramètres agent_id et customer_id :

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

exemple de sortie :

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

F) API Forecast Insight

La latence projetée utilise les 5 dernières minutes ; l'intervalle de prévision et le niveau de confiance sont calculés sur les 10 dernières minutes de données de latence.

Cette API fournit les dernières mesures prévues en utilisant une moyenne statistique et une projection.

Utilisée avec le point de terminaison /api/v1/forecast. Vous pouvez ajouter les paramètres agent_id et customer_id :

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

exemple de sortie :

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

G) API Radio Insight

Le dernier instantané utilise les 10 dernières secondes ; avec time_range ou chosen_time, les données sont retournées pour cette fenêtre personnalisée.

Cette API fournit les dernières mesures radio/cellulaires.

Utilisée avec le point de terminaison /api/v1/radio. Vous pouvez ajouter les paramètres agent_id et customer_id :

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

exemple de sortie :

{
    "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"
}

Optionnel : l'utilisation du paramètre chosen_time vous permet d'interroger les données pour une période donnée, format start_time,end_time (ex : 2025-05-30T10:00:00Z,2025-06-15T17:00:00Z) L'heure spécifiée doit être en UTC, ou le fuseau horaire configuré pour l'Analyzer (UTC par défaut)

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

exemple de sortie :

[
  {
    "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

Liste les customer IDs vus dans la dernière heure.

Cette API fournit les customer_id de l'Analyzer.

Utilisée avec le point de terminaison /api/v1/networks. Vous n'avez besoin d'aucun paramètre

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

exemple de sortie :

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

I) API Agents

Liste les agents actifs dans les 20 dernières secondes ; les métadonnées (si demandées) proviennent de la dernière semaine.

Cette API fournit les customer_id de l'Analyzer.

Utilisée avec le point de terminaison /api/v1/agents. Vous pouvez ajouter le paramètre customer_id et le paramètre optionnel metadata=true pour également recevoir les métadonnées de chaque agent :

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

exemple de sortie :

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

Nécessite time_range ou chosen_time ; la latence est agrégée en fenêtres de 30 secondes.

Cette API détecte et signale les anomalies réseau sur tous les protocoles avec des métriques détaillées incluant le MAD d'anomalie (Écart Absolu Médian), les pertes de paquets, les pics de latence et les modèles de distribution d'anomalies.

Utilisée avec le point de terminaison /api/v1/anomalies. Vous pouvez ajouter les paramètres agent_id, customer_id, le protocol optionnel (tcp, udp, http, https, icmp, twamp), et time_range (en secondes) :

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"

exemple de sortie :

{
    "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": "Le protocole TCP montre des indicateurs d'anomalie élevés"
}

Compare la latence moyenne de la dernière heure à une référence sur les N jours précédents (par défaut 7, jusqu'à hier).

Cette API analyse les tendances de performance des agents au fil du temps, en comparant les performances actuelles aux références historiques pour identifier les modèles de dégradation et l'état des performances.

Utilisée avec le point de terminaison /api/v1/trends. Vous pouvez ajouter les paramètres agent_id, customer_id et le paramètre optionnel lookback_days :

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"

exemple de sortie :

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

Agrège la latence moyenne sur la période du rapport : 1 jour (daily), 7 jours (weekly), ou 30 jours (monthly).

Cette API génère des rapports complets sur la santé du réseau avec la distribution des performances des agents, les classements et des recommandations exploitables pour l'optimisation du réseau.

Utilisée avec le point de terminaison /api/v1/health-report. Vous pouvez ajouter les paramètres customer_id, le report_period optionnel (daily, weekly, monthly) et include_recommendations (true/false) :

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"

exemple de sortie :

{
    "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": [
        "5 agents au total surveillés",
        "3 agents performent bien", 
        "1 agents nécessitent une attention",
        "1 agents nécessitent une enquête immédiate",
        "Priorité : Enquêter sur les agents ayant un statut POOR"
    ]
}

M) API Agent Rankings

Classe les agents avec la latence moyenne sur time_range secondes (par défaut 24 heures).

Cette API classe tous les agents selon les métriques de performance et les tendances, en identifiant les meilleurs et les moins bons performeurs avec des scores de performance détaillés et une analyse comparative.

Utilisée avec le point de terminaison /api/v1/agent-rankings. Vous pouvez ajouter les paramètres customer_id, la metric optionnelle (latency, stability, connectivity_health, overall) et time_range (en secondes) :

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"

exemple de sortie :

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

Analyse la latence sur time_range secondes (par défaut 2 heures), agrégée en fenêtres de 5 minutes.

Cette API détecte les modèles de corrélation entre les agents pour identifier les problèmes à l'échelle du réseau affectant plusieurs emplacements, avec une analyse statistique de corrélation et une classification des modèles.

Utilisée avec le point de terminaison /api/v1/correlation-analysis. Vous pouvez ajouter les paramètres customer_id, le correlation_threshold optionnel (0.0-1.0) et time_range (en secondes) :

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"

exemple de sortie :

{
    "CustomerID": "0",
    "time": "2025-01-15T14:30:45.123Z",
    "correlationThreshold": 0.7,
    "timeRangeSeconds": 7200,
    "totalAgentsAnalyzed": 4,
    "patternsFound": 2,
    "patterns": [
        {
            "description": "Agents présentant des modèles similaires de dégradation de la latence",
            "affectedAgents": ["1", "2", "4"],
            "correlationStrength": 0.85,
            "patternType": "similar_degradation",
            "severity": "MEDIUM", 
            "recommendation": "Enquêter sur l'infrastructure réseau partagée - plusieurs agents affectés de manière similaire"
        },
        {
            "description": "Agents présentant des modèles de latence inversés",
            "affectedAgents": ["3", "5"],
            "correlationStrength": 0.72,
            "patternType": "inverse_pattern", 
            "severity": "LOW",
            "recommendation": "Vérifier le comportement de l'équilibrage de charge ou du basculement affectant différents agents"
        }
    ]
}

O) API Degradation Alerts

Compare la latence moyenne de la dernière heure à une référence sur days_lookback jours (par défaut 3, jusqu'à hier).

Cette API identifie de manière proactive les agents présentant une dégradation des performances au-dessus de seuils configurables, avec une classification de gravité et une analyse détaillée de la dégradation.

Utilisée avec le point de terminaison /api/v1/degradation-alerts. Vous pouvez ajouter les paramètres customer_id, le severity_threshold optionnel (pourcentage) et days_lookback :

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&days_lookback=3"

exemple de sortie :

{
    "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": "L'agent 3 présente une dégradation des performances de 45,2 % sur 3 jours"
        },
        {
            "agentID": "2", 
            "degradationPercent": 22.8,
            "currentLatency": 55.3,
            "baselineLatency": 45.0,
            "severity": "MEDIUM",
            "message": "L'agent 2 présente une dégradation des performances de 22,8 % sur 3 jours"
        }
    ]
}

P) API iPerf Throughput Insight

Retourne le dernier débit iPerf TCP et UDP des 12 dernières heures.

Cette API retourne le débit TCP et UDP issu des mesures iPerf pour un QoSAgent donné.

Utilisée avec le point de terminaison /api/v1/iperf. Vous pouvez ajouter les paramètres agent_id et customer_id :

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

exemple de sortie :

{
    "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
    }
}

Définition de l'API

Un fichier de définition d'API conforme à la norme OpenAPI est disponible au format yml. Vous pouvez télécharger le fichier ici :

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

Troubleshooting

customerID is required ou agentID is required.

Il est possible, selon l'environnement que vous utilisez, que la partie Analyzer de la requête doive être entre guillemets :

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