DOCS

API-Nutzung

API-Nutzung

Überwachen Sie das API-Aufkommen und die Nutzung nach Produkt Ihrer Organisation und exportieren Sie Ihren Nutzungsverlauf als CSV.

Die Seite Usage im Dashboard zeigt, wie Ihre Organisation die Zonos-API im Zeitverlauf nutzt. Sie sehen Ihr gesamtes Aufrufvolumen, welche Produkte Sie am häufigsten nutzen und wie sich die Nutzung monatlich entwickelt – und können die zugrunde liegenden Daten als CSV-Datei für Abstimmung, Abrechnungsprüfung oder tiefere Analysen exportieren.

Öffnen Sie die Seite, indem Sie sich im Dashboard anmelden und in der linken Navigation Usage auswählen.

Dashboard lesen 

Oben auf der Seite fassen zwei Karten Ihre Aktivität für den ausgewählten Zeitraum zusammen:

  • Total API calls — Die Gesamtzahl der API-Aufrufe im ausgewählten Zeitraum. Bei monatlicher Granularität zeigt diese Karte auch die prozentuale Veränderung im Vergleich zum Vormonat.
  • Most used API — Das Zonos-Produkt, das Sie am häufigsten aufrufen.

Unter den Karten zeigt das Diagramm API volume Ihre Aufrufe im Zeitverlauf als gestapeltes Balkendiagramm, farbcodiert nach Produkt. Darunter listet API type breakdown jedes Produkt mit Aufrufanzahl und Anteil an der Gesamtnutzung auf.

Nutzen Sie die Steuerelemente über dem Diagramm, um die Ansicht anzupassen:

  • Date range — Wählen Sie 1 month, 3 months oder 6 months.
  • Granularity — Gruppieren Sie Aktivitäten nach Daily, Weekly oder Monthly.

Welche API-Produkte werden erfasst 

Die Nutzung wird pro Zonos-Produkt gemeldet, damit Sie genau sehen, wohin Ihre Aufrufe gehen:

ProductDescription
ClassifyHS-Code-Klassifizierungsanfragen
Landed CostZoll-, Steuer- und Gebührenberechnungen
Order CompleteÜber die Zonos-API abgeschlossene Bestellungen
Denied PartyDenied-Party-(Screen)-Prüfungsanfragen
Restricted ItemArtikelbeschränkungs-(Restrict)-Prüfungen

Nutzung als CSV exportieren 

So laden Sie eine CSV Ihres Nutzungsverlaufs herunter:

  1. Klicken Sie auf der Seite Usage auf Export.
  2. Wählen Sie im Dialog Download API usage CSV einen Date range. Wählen Sie eine Voreinstellung – This month, Last month, Last 7 days, Last 30 days, Last 90 days, This quarter, Last quarter, Year to date oder Last year – oder wählen Sie Custom und legen Sie Start date und End date fest.
  3. Wählen Sie unter API types, welche Produkte einbezogen werden sollen. Standardmäßig sind alle unterstützten Produkte ausgewählt.
  4. Wählen Sie eine GranularityDaily, Weekly oder Monthly – um zu steuern, wie Zeilen nach Datum gruppiert werden.
  5. Klicken Sie auf Download.

Der Dialog öffnet sich mit dem auf der Seite angezeigten Datumsbereich und der Granularität vorausgefüllt, sodass Sie die aktuelle Ansicht mit einem Klick exportieren können.

Die exportierte Datei enthält folgende Spalten:

ColumnDescription
PeriodDer Datums-Bucket für die Zeile, basierend auf der gewählten Granularität
API TypeDas Zonos-Produkt, zu dem die Aufrufe gehören
Call CountDie Anzahl der API-Aufrufe für dieses Produkt in diesem Zeitraum

Note: Wenn keine Nutzung den ausgewählten Filtern entspricht, wird keine Datei heruntergeladen und das Dashboard informiert Sie, dass nichts zu exportieren war. Versuchen Sie, den Datumsbereich zu erweitern oder mehr API-Typen auszuwählen.

Hinweis zur Migration der Nutzungsdaten 

Zonos ist kürzlich auf ein verbessertes API-Nutzungs-Tracking-System migriert. Nutzungsdaten vor der Migration können unvollständig oder fehlend sein – das ist erwartet. Alle künftige Nutzung wird genau erfasst.

War diese Seite hilfreich?