Aperçu

La page des rapports d'API vous montre ce qui se passe avec l'activité de votre API en temps réel, sur l'ensemble de votre compte. Elle est conçue pour vous offrir une tranquillité d'esprit, afin que vous puissiez voir rapidement ce qui fonctionne, repérer les problèmes tôt et comprendre comment vos systèmes communiquent.

Les rapports sont conservés pendant 7 jours et incluent :

Requêtes réussies
Requêtes échouées
Rapports détaillés pour chaque requête
Charges utiles complètes des requêtes et des réponses

Vous pouvez utiliser cette page pour vérifier si les requêtes ont été livrées avec succès, examiner les erreurs et suivre l'activité sur l'ensemble de vos services connectés, le tout depuis une vue simple.

Accéder à la page des rapports d'API

Dans le menu de gauche, recherchez Développeuses.
Cliquez sur Outils de la développeuse > Rapports d'API

Composants

1. Résumé : 'Votre activité récente'

Ces statistiques vous donnent une visibilité instantanée sur votre utilisation de l'API.
Affiche les chiffres globaux pour la plage de dates sélectionnée :

Total des requêtes : Toutes les requêtes d'API effectuées.
Réussies : Requêtes renvoyant les états du service 200 et 201
Échouées : Requêtes renvoyant les états du service 400, 401, 403, 404 et 50

2. Recherche, Filtres & Appliquer

La fonctionnalité de recherche et de filtres vous aide à trouver rapidement les rapports que vous recherchez. Vous pouvez rechercher par mots-clés, filtrer par état du service ou affiner par date pour vous concentrer sur les requêtes les plus importantes.

Cette fonctionnalité s'applique aux quatre pages de rapports qui sont initialement chargées. Pour rechercher ou filtrer parmi plus d'enregistrements, chargez simplement des pages supplémentaires en cliquant sur les pages suivantes, votre recherche et vos filtres s'appliqueront alors également aux rapports nouvellement chargés.

Rechercher
Saisissez des mots complets ou partiels, et la recherche parcourra tous les champs suivants pour vous aider à trouver rapidement ce dont vous avez besoin.
Voici les options de recherche possibles :
- Point de terminaison d'API : Le chemin d'API spécifique qui est appelé.
- Identifiant de requête : Un identifiant unique assigné automatiquement à chaque requête d'API.
- Source : L'origine de la requête (par ex., API, tableau de bord, sous-compte).
- Corps : Le contenu de la requête, y compris le texte du message et les paramètres.
- Pays : Le pays de destination du message d'après le numéro du destinataire.
- Identifiant de l'expéditeur : La valeur "de" utilisée lors de l'envoi du message (alphanumérique ou numéro).
- Code de réponse : Le code numérique du système renvoyé après le traitement de la requête.
- Message de réponse : Un bref message expliquant le code de réponse.
- Code d'erreur : l'état du service HTTP de l'appel
- Message d'erreur : Une courte explication de ce qui a causé l'erreur.
- Identifiant du message : L'identifiant unique du message individuel une fois mis en file d'attente ou envoyé.
Filtres
- État du service : Filtrer par succès, erreurs client ou erreurs serveur.
- Point de terminaison : Filtrer par ex., /v3/sms/send, /v3/mms/send, /v3/sms/history, etc.
- Sous-compte : Par défaut, ce sera votre sous-compte.
- Plage de dates : Nous ne conservons les rapports que pendant 7 jours. Vous pouvez sélectionner parmi ces options :
  - Aujourd’hui
  - Les 12 dernières heures
  - Les 24 dernières heures
  - Il y a 2 jours
  - Il y a 3 jours
  - Il y a 4 jours
  - Il y a 5 jours
  - Il y a 6 jours
“Remarque : Lorsque vous utilisez le filtre « Il y a 2 jours », il affichera tous les rapports des deux derniers jours, y compris aujourd'hui.
Boutons
- Effacer les filtres : Réinitialise tous les filtres, y compris la recherche.
- Appliquer : Utilisez ceci pour appliquer vos filtres et recherche actuels. Vous pouvez soit cliquer sur « Appliquer », soit simplement appuyer sur Entrée pour lancer la recherche.

3. Tableau des rapports

Permet d'afficher toutes les requêtes d'API en fonction de vos filtres. Les colonnes comprennent :

Utilisez ce tableau pour analyser rapidement l'activité ou identifier les appels défaillants.

Tri :

Vous pouvez trier par n'importe quelle colonne telle que l'Horodatage ou l'État du service.
Cliquer sur un en-tête de colonne bascule entre l'ordre croissant et décroissant.
Cette aide vous permet de regrouper les erreurs, l'activité récente ou des points de terminaison spécifiques plus efficacement.

Interactions :

Cliquer sur une ligne permet les ouvertures des détails complets de la requête sur le panneau de droite.
La pagination vous permet de naviguer à travers tous les rapports et charge les données suivantes.
Rafraîchir le tableau recharge les derniers rapports.
Tri

Panneaux détaillés des rapports (Métadonnées, panneaux de requête et de réponse)
Lorsque vous sélectionnez une ligne, les détails complets apparaissent.

Le panneau des métadonnées comprend :
- Méthode
- Statut
- État du service du message (par ex., 200 Succès)
- Identifiant de la requête
- Sous-compte
- Horodatage
- Adresse IP du client
- Agent utilisateur
Cette section aide à identifier d'où provient la requête (Postman, serveur, navigateur, etc.).

Corps de la requête
Affiche exactement la charge utile envoyée. Utile pour :
- Débugger un JSON malformé
- Vérifier les paramètres
- Vérifier les méthodes d'authentification
Corps de la réponse
Affiche la réponse exacte retournée. Comprend :
- Codes HTTP
- Messages d'erreur
- Codes de réponse internes
- Données de livraison et tarifs (le cas échéant)
C'est votre outil principal pour résoudre les problèmes tels que les échecs, les erreurs de message ou les charges utiles incorrectes.

Études de cas courantes

1. Débugger les appels API échoués

Ouvrir le menu déroulant du filtre État du service
Cliquer sur une ligne contenant 400 ou 500.
Récapitulatif:
- Corps de la réponse (message d'erreur)
- Corps de la requête (champs incorrects ?)
- Point de terminaison utilisé
- Sous-compte qui l'a déclenché

2. Confirmer que le service de messagerie simple/MMS a été envoyé avec succès

Filtrer le point de terminaison /v3/sms/send.
Vérifier l'état du service 200.
Inspecter le corps de la réponse → Message queued for delivery.

3. Reproduire ou faire remonter les problèmes

Copiez directement les corps de la requête/réponse lors de la soumission de rapports de problèmes.

Conseils

Utilisez la recherche pour trouver rapidement des rapports pour un numéro de téléphone ou un mot-clé spécifique.
Pour les problèmes récurrents, comparez plusieurs rapports côte à côte.
Les rapports se rafraîchissent automatiquement après avoir cliqué sur Rafraîchir le tableau.
Utilisez la charge utile de la réponse pour comprendre les problèmes de tarifs ou de livraison.

FAQ

Qu'est-ce que la page des rapports d'API ?

La page des rapports d'API permet aux développeuses de voir et de suivre toutes les requêtes d'API effectuées via leur compte. Cela aide à suivre l'activité des requêtes, à identifier les erreurs et à débugger les intégrations en temps réel.

Quelles informations puis-je voir dans les rapports d'API ?

Chaque entrée de rapport inclut des détails clés tels que :

Horodatage – Quand la requête a été effectuée
Point de terminaison – Quel point de terminaison d'API a été appelé
État du service – Si la requête a réussi ou échoué
Code de réponse – Code d'état du service HTTP (par ex., 200, 400, 500)
Identifiant de la requête – Un identifiant unique pour chaque requête

Que sont les compteurs « Tous », « Succès » et « Échec » ?

Ces compteurs résument l'activité de vos requêtes d'API :

Tous – Affiche le nombre total d'appels API effectués
Succès – Affiche le nombre de requêtes terminées de manière complète avec succès
Échec – Affiche le nombre de requêtes ayant entraîné une erreur

Comment fonctionne la pagination sur la page des rapports ?

Les rapports sont affichés sur plusieurs pages pour rendre la navigation plus rapide et plus facile.

Utilisez les éléments pour contrôler la pagination (par ex., Suivant, Précédent, ou les pages numérotées) pour naviguer à travers l'historique de vos rapports.

Que fait le bouton « Rafraîchir » ?

Le bouton Rafraîchir recharge le tableau des rapports pour afficher l'activité d'API la plus récente sans recharger l'intégralité du tableau de bord.

Ceci est utile lors du suivi des requêtes d'API en direct.

À quelle fréquence les rapports sont-ils mis à jour ?

Les rapports sont mis à jour en temps quasi réel. Vous pouvez cliquer manuellement sur Rafraîchir pour obtenir les dernières données instantanément.

Jusqu'à quand puis-je consulter les rapports d'API ?

Vous pouvez consulter les rapports des 7 derniers jours.

Les rapports plus anciens peuvent être archivés ou supprimés automatiquement.

Puis-je exporter mes rapports d'API ?

Actuellement, la fonctionnalité d'exportation peut ne pas être disponible directement sur la page.

Puis-je rechercher ou filtrer mes rapports d'API ?

Oui . Vous pouvez filtrer les rapports par :

État du service (Succès, Échec)
Plage de dates
Point de terminaison
Recherche - tapez n'importe quel mot-clé

Que dois-je faire si une requête a échoué ?

Vous pouvez :

Cliquer sur l'entrée de rapport échouée pour voir les détails et les messages d'erreur
Vérifiez le code de réponse et le corps de l'erreur
Utilisez ces données pour résoudre les problèmes de votre intégration d'API

Qui peut accéder à la page des rapports d'API ?

Le compte et le sous-compte peuvent accéder et consulter leurs rapports d'API. Dans cette version, les paramètres font qu'un sous-compte ne peut voir que les siens.

Guides des rapports d'API