Tableau de bord d’utilisation de l’API
Le tableau de bord d’utilisation de l’API vous permet de surveiller le trafic entrant de l’API REST vers Braze, de comprendre les tendances d’utilisation de nos API REST et de résoudre d’éventuels problèmes.
À propos du tableau de bord d’utilisation de l’API
Pour afficher votre tableau de bord d’utilisation de l’API, accédez à Paramètres > API et identifiants, puis sélectionnez Tableau de bord.
Le tableau de bord par défaut affiche toutes les requêtes entrantes de l’API REST pour votre espace de travail au cours des dernières 24 heures. Selon votre cas d’usage, vous pouvez ajuster les contrôles du tableau de bord pour filtrer ou regrouper le trafic, et également configurer la plage temporelle du tableau de bord.
Indicateurs disponibles
Le tableau de bord d’utilisation de l’API comprend les statistiques suivantes :
| Indicateur | Description |
|---|---|
| Nombre total de requêtes | Le nombre total de requêtes envoyées à Braze pour votre espace de travail actuel, en fonction des filtres et contrôles appliqués au tableau de bord. |
| Taux de réussite | Le pourcentage du nombre total de requêtes pour lesquelles Braze a renvoyé une réponse de succès 2XX. |
| Taux d’erreur | Le pourcentage du nombre total de requêtes pour lesquelles Braze a renvoyé une réponse d’erreur 4XX ou 5XX. |
Utiliser le tableau de bord
Filtres
Sélectionnez Filtres pour appliquer des filtres et affiner la vue du trafic REST API de votre espace de travail, notamment :
- Clé API
- Endpoint
- Code de réponse
Regroupement des données
Vous pouvez regrouper les données en différentes séries pour explorer divers schémas d’utilisation, notamment :
- Codes de réponse (par défaut)
- Endpoint API
- Clé API
- Succès et échecs uniquement
Date
Ajustez le filtre de date pour afficher une plage temporelle plus courte ou plus longue selon vos besoins. Les options disponibles sont :
- Aujourd’hui (par défaut)
- Personnalisé
- 3 dernières heures
- 6 dernières heures
- 12 dernières heures
- 24 dernières heures
- Hier
- 7 derniers jours
- 14 derniers jours
- 30 derniers jours
- Mois en cours
Les options 3 dernières heures et 6 dernières heures affichent le trafic par minute. Les périodes plus longues affichent le trafic toutes les cinq minutes, par heure ou par jour.
Considérations
Le tableau de bord d’utilisation de l’API inclut toutes les requêtes REST API que Braze a reçues et pour lesquelles une réponse 2XX, 4XX ou 5XX a été renvoyée. Cela comprend les sorties de Data Transformation et les synchronisations Cloud Data Ingestion. Le trafic SDK et les étapes User Update ne sont pas inclus dans ce tableau de bord.
Les données affichées dans le tableau de bord peuvent présenter un court délai avant d’afficher le trafic récent. Pendant les périodes de forte utilisation, vous pouvez actualiser le tableau de bord jusqu’à 4 fois par minute. Il peut être nécessaire d’attendre quelques minutes avant d’actualiser à nouveau le tableau de bord.
Clés API dans le corps de la requête
Lorsque les clés API sont envoyées dans le corps de la requête plutôt que dans l’en-tête de la requête, certaines requêtes peuvent ne pas apparaître dans le tableau de bord d’utilisation de l’API. Cela peut entraîner des données incomplètes dans le tableau de bord et rendre difficile le suivi précis de l’utilisation de l’API.
Pour un reporting aussi précis que possible dans le tableau de bord d’utilisation de l’API, incluez les clés API dans l’en-tête de la requête plutôt que dans le corps de la requête.