Reports API Bewährte Praktiken

Auf dieser Seite finden Sie Best Practices für die effektive Nutzung der Vonage Reports API.

Optimieren von Anfragen mit Filtern

Nutzen Sie die Filteroptionen, um Ihre Anfragen individuell zu gestalten. Die verfügbaren Reports API-Filter hängen vom angeforderten Produkt ab. Weitere Einzelheiten finden Sie in der Abfrageparameter für die synchrone Methodeund in der Anfragekörper für die asynchrone Methode.

Die Verwendung von Filtern hilft dabei, nur die erforderlichen Daten abzurufen, die API-Aufrufe zu optimieren und die Kosten für die Anfrage des Benutzers zu senken.

Die beliebtesten Filter sind:

  • Filtern nach Datumsbereich (date_start, date_end)
  • Filterung durch id um den aktuellen Status des genauen Ereignisses (Nachricht/Anruf usw.) zu erhalten - wird nur von synchronen Endpunkten unterstützt
  • Filtern nach Telefonnummern (to, from, usw.)

Best Practices für die Überwachung des Nachrichtenstatus

Um den aktuellen Status der Nachricht zu überwachen, sollten Sie den Bericht mit der Funktion id Abfrageparameter - dies ist verfügbar für die synchron Methode. Diese Methode ist wesentlich effizienter als die mehrfache Abfrage derselben Daten.

Optimierung von Anfragen mit all Ihren Sub-Accounts

Wenn Sie den Bericht für ein Hauptkonto mit allen Unterkonten anfordern möchten und die Anzahl der Unterkonten mehr als 10 beträgt, sollten Sie den folgenden Ablauf beachten, um Ihren Bericht schneller zu erhalten:

  1. Rufen Sie die Unterkonten API um die aktuelle Liste aller Unterkonten zu erhalten, die mit Ihrer Master-Konto-ID verbunden sind.
  2. Rufen Sie Reports API für jedes Unterkonto separat und für Ihre Master-Konto-ID ohne Unterkonten auf.

Verständnis der Preisgestaltung und des Preismodells "Pay as you go

Mit dem Bezahlen Sie, wie Sie wollen Preismodell werden Sie pro Datensatz im Bericht belastet. Siehe diese Seite um Beispiele zu sehen. Wenn Sie denselben CDR in mehreren Berichten anfordern, werden Sie mehrfach belastet.

Um eine Vorstellung davon zu bekommen, wie viele CDRs Sie für einen bestimmten Zeitraum erhalten können, navigieren Sie zu Dashboard und gehen Sie dann zum Analytik im linken Navigationsmenü. Auf diese Weise können Sie den Preis für Ihren Bericht leichter abschätzen.

Beschränkungen bei der Handhabung

  • Asynchrone Endpunktbegrenzung - Derzeit können Sie einen archivierten Bericht mit einer maximalen Größe von 1 GB erstellen. Das sind etwa 7 Millionen Datensätze. Je nach Produkt kann die Zahl bei Berichten mit weniger Spalten höher sein. Um die Anzahl der Datensätze in einem Bericht zu reduzieren, sollten Sie versuchen, die Daten in Stücken zu erhalten. Sie können Ihre Daten nach Zeitspanne, Status, Telefonnummer usw. filtern. Prüfen Sie Preisgestaltung für Einzelheiten.
  • Höchstsätze - Achten Sie auf die Preisgrenze. Reports API unterstützt bei asynchroner Verwendung fünf Anfragen pro Sekunde und bei synchroner Verwendung zehn Anfragen pro Sekunde. Bei Überschreitung dieser Grenzen wird eine HTTP 429: Too Many Requests Fehler.

Die Wahl zwischen der synchronen und der asynchronen Methode

Wenn Sie Daten in kleinen Stücken schneller erhalten möchten, verwenden Sie die synchron Methode (es ist möglich, eine unbegrenzte Anzahl von Datensätzen vom Sync-Endpunkt in 1000 Datenpaketen zu erhalten).

Wenn Sie planen, größere Datensätze (mehr als 10.000 Datensätze) zu erhalten, verwenden Sie die asynchrone Methode. Die synchrone Methode ist am besten für Kunden geeignet, die Echtzeitdaten für ihre Dashboards oder internen Speicher benötigen. Der Vorteil der asynchronen Methode besteht darin, dass die Nutzer ihre Berichte als CSV-Dateien erhalten, die sie für weitere manuelle Analysen verwenden können. Außerdem können die Nutzer mit dem asynchronen Bericht Daten für alle ihre Unterkonten in einem Bericht erhalten.

Effektive Überwachung der API-Nutzung

Implementieren Sie eine interne Überwachung, um Ihre API-Nutzungsmuster zu verfolgen, oder verwenden Sie die Reports API mit dem Produkt REPORTS-USAGE zu Informationen über Ihre Reports API-Nutzung erhalten. Es ist kostenlos und die Daten sind für die letzten 13 Monate verfügbar - dies wird Ihnen helfen, mögliche Ineffizienzen zu erkennen, Ihre Anwendung zu optimieren und das geplante Budget einzuhalten.