Reports API Meilleures pratiques

Cette page présente les meilleures pratiques pour utiliser efficacement l'API Reports de Vonage.

Optimiser les demandes avec des filtres

Profitez des options de filtrage pour adapter vos demandes. Les filtres de Reports API disponibles dépendent du produit demandé. Pour plus de détails, voir la page paramètres de requête pour la méthode synchroneet dans le corps de la requête pour la méthode asynchrone.

L'utilisation de filtres permet de ne récupérer que les données nécessaires, ce qui optimise les appels à l'API et réduit le coût des requêtes de l'utilisateur.

Les filtres les plus populaires sont les suivants :

  • filtrage par plage de dates (date_start, date_end)
  • filtrage par id pour obtenir l'état actuel de l'événement exact (message/appel, etc.) - supporté uniquement par le point de terminaison synchrone
  • filtrage par numéros de téléphone (to, frometc.)

Bonnes pratiques pour le suivi de l'état des messages

Pour suivre l'état le plus récent du message, vous devez demander le rapport à l'aide de la fonction id paramètre de la demande - cette option est disponible pour le synchrone uniquement. C'est une méthode beaucoup plus efficace que de demander plusieurs fois les mêmes données.

Optimiser les requêtes avec tous vos sous-comptes

Si vous envisagez de demander le rapport pour un compte principal avec tous ses sous-comptes, et que le nombre de sous-comptes est supérieur à 10, suivez la procédure suivante pour obtenir votre rapport beaucoup plus rapidement :

  1. Appeler le API sous-comptes pour obtenir la liste de tous les sous-comptes liés à l'ID de votre compte principal.
  2. Appelez Reports API pour chaque sous-compte séparément et pour l'ID de votre compte principal sans sous-compte.

Comprendre la tarification et le modèle de tarification "Pay as You Go

Avec la Payez au fur et à mesure vous serez facturé par enregistrement dans le rapport. Se référer à cette page pour voir des exemples. Si vous demandez le même CDR dans plusieurs rapports, vous serez facturé plusieurs fois.

Pour avoir une idée du nombre de CDR que vous pouvez obtenir pour une période donnée, naviguez vers Tableau de bord et se rendre ensuite à la page Analyse dans le menu de navigation de gauche. Il vous sera ainsi plus facile d'estimer le prix de votre rapport.

Limites de manipulation

  • Limite de l'extrémité asynchrone - Actuellement, vous pouvez produire un rapport archivé d'une taille maximale de 1 Go. Cela représente environ 7 millions d'enregistrements. Selon le produit, ce chiffre peut être plus élevé pour ceux qui comportent moins de colonnes. Pour réduire le nombre d'enregistrements dans un rapport, essayez d'obtenir les données par morceaux. Vous pouvez filtrer vos données par période, par statut, par numéro de téléphone, etc. Vérifier la tarification pour plus de détails.
  • Limites de taux - Soyez conscient de l'importance de la limite de taux. Reports API prend en charge cinq requêtes par seconde lorsqu'elle est utilisée de manière asynchrone, et dix requêtes par seconde de manière synchrone. Le dépassement de ces limites entraîne l'envoi d'un message HTTP 429: Too Many Requests erreur.

Choisir entre la méthode synchrone et la méthode asynchrone

Si vous souhaitez obtenir des données en petits morceaux plus rapidement, utilisez la fonction synchrone (Il est possible d'obtenir un nombre illimité d'enregistrements à partir du point de terminaison de synchronisation en 1000 morceaux de données).

Si vous prévoyez d'obtenir des ensembles de données plus importants (plus de 10 000 enregistrements), utilisez la fonction asynchrone méthode. La méthode synchrone convient mieux aux clients qui ont besoin de données en temps réel pour leurs tableaux de bord ou leurs stockages internes. L'avantage de la méthode asynchrone est qu'elle permet aux utilisateurs de recevoir leurs rapports sous forme de fichiers CSV, qui peuvent être utilisés pour d'autres analyses manuelles. De plus, avec le rapport asynchrone, les utilisateurs peuvent obtenir des données pour tous leurs sous-comptes dans un seul rapport.

Contrôler efficacement l'utilisation de l'API

Mettre en place une surveillance interne pour suivre les schémas d'utilisation de votre API, ou utiliser l'API Reports avec le produit. REPORTS-USAGE à obtenir des informations sur l'utilisation de l'API Reports. C'est gratuit et les données sont disponibles pour les 13 derniers mois - cela vous aidera à identifier toute inefficacité potentielle, à optimiser votre application et à rester dans le budget prévu.