Geplante Exporte über die Analytics API

Die Analytics API, verfügbar für Analytics+-Kunden, ermöglicht es Ihnen, Anruf- und Nutzermetriken direkt in Ihre eigenen Reporting-Tools zu übertragen, ohne Daten manuell aus dem Aircall Dashboard exportieren zu müssen. Sie können wiederkehrende Exporte täglich, wöchentlich oder monatlich automatisieren und die Daten verwenden, um benutzerdefinierte Berichte zu erstellen, die auf Ihr Unternehmen zugeschnitten sind.

Dieser Artikel behandelt, was die Analytics API bietet, wie sie funktioniert und was Sie beim Einrichten automatisierter Exporte beachten sollten.

Achtung: Die Analytics API ist ausschließlich für Kunden mit dem A+ Add-on verfügbar. Wenn Sie nicht sicher sind, ob Ihr Tarif A+ umfasst, wenden Sie sich an das Customer-Success-Team.

Was Sie exportieren können

Die API gibt Ihnen Zugriff auf drei Datenkategorien:

• Verlauf: Detaillierte Aufzeichnungen eingehender und ausgehender Anrufe.
• User Status History+: Ein Protokoll des Verfügbarkeitsstatus von Agenten im Zeitverlauf.
• Nutzeraktivität: Ein Satz benutzerspezifischer Leistungsmetriken, einschließlich Anrufvolumen, Gesprächszeit, Bearbeitungszeit nach jedem Anruf, Klingelversuchen und der in jedem Status verbrachten Zeit.

Jede Kategorie entspricht den im Aircall Dashboard verfügbaren Berichten. Die vollständige Liste exportierbarer Berichte und der entsprechenden API-Parameterwerte finden Sie in der Analytics API-Dokumentation.

Filter und Parameter

Jede API-Anfrage erfordert die folgenden Parameter:

• Berichtstyp: Der spezifische Bericht, den Sie exportieren möchten. Die vollständige Liste finden Sie in der Analytics API-Dokumentation.
• Datumsbereich: Der Zeitraum, den der Export abdecken soll.
• Zeitzone: Die auf die Daten angewendete Zeitzone. Standardmäßig UTC, wenn nicht angegeben.

Sie können auch optionale Filter übergeben, um die Ergebnisse einzugrenzen, entsprechend den Filtern, die für jeden Bericht im Aircall Dashboard verfügbar sind. Die verfügbaren optionalen Filter variieren je nach Berichtstyp. Die vollständige Liste pro Bericht finden Sie in der Analytics API-Dokumentation.

Achtung: Anfragen ohne einen erforderlichen Parameter schlagen fehl. Testen Sie jeden Berichtstyp mit allen erforderlichen Parametern, bevor Sie automatisierte Exporte planen.

So funktioniert die API

Die API folgt einem einfachen Anfrage-und-Download-Ablauf:

Schritte:

1. Authentifizieren Sie Ihre Anfrage mit Ihren API-Zugangsdaten. Diese finden Sie in Ihrem Aircall Dashboard unter Integrationen & API.
2. Rufen Sie den einzelnen Endpunkt auf und übergeben Sie Ihren gewählten Berichtstyp, einen erforderlichen Datumsbereich und eine Zeitzone als Parameter.
3. Sie erhalten eine Antwort mit einem vorab signierten Link zu einer CSV-Datei.
4. Laden Sie die CSV über diesen Link herunter. Der Link läuft 1 Stunde nach seiner Generierung ab. Richten Sie Ihren Arbeitsablauf daher so ein, dass der Download unmittelbar nach jeder erfolgreichen Antwort erfolgt.

Eine Zeitplanung ist nicht in die API integriert. Wenn Sie tägliche, wöchentliche oder monatliche Exporte möchten, müssen Sie diese Automatisierung auf Ihrer Seite mit Ihrer eigenen Infrastruktur oder einem Drittanbieter-Tool zur Zeitplanung einrichten.

Einzelheiten zur Authentifizierung, zum Endpunkt und die vollständige Parameterreferenz finden Sie in der Analytics API-Dokumentation.

Datenspeicherung

Die über die API verfügbaren Daten unterliegen denselben Aufbewahrungsgrenzen wie im Aircall Dashboard:

Best Practices

Die folgenden Empfehlungen gelten unabhängig davon, ob Sie einmalige Exporte ausführen oder eine vollständig automatisierte Pipeline aufbauen.

Exporte außerhalb der Geschäftszeiten planen 

Wenn möglich, lösen Sie automatisierte Exporte außerhalb der Geschäftszeiten aus. Das verringert das Risiko von Verzögerungen in Zeiten hoher API-Auslastung und trägt dazu bei, eine konsistente Datenverfügbarkeit sicherzustellen.

Nach jeder Anfrage sofort herunterladen

Der Download-Link läuft nach 1 Stunde ab. Richten Sie Ihre Automatisierung so ein, dass die Datei sofort nach Erhalt der API-Antwort heruntergeladen wird, anstatt den Link für einen späteren Abruf zu speichern.

Zeilenlimits Ihres Zielsystems prüfen

Die API setzt kein Zeilenlimit für Exporte. Einige Import-Tools und Tabellenkalkulationsanwendungen begrenzen jedoch die Anzahl der Zeilen, die sie verarbeiten können. Prüfen Sie die Limits Ihres Zielsystems, bevor Sie große Exporte in der Produktionsumgebung ausführen.

Vor der Automatisierung testen

Führen Sie jeden Berichtstyp manuell aus, bevor Sie wiederkehrende Exporte planen. So können Sie fehlende oder falsche Parameter frühzeitig erkennen, bevor sie in einem automatisierten Arbeitsablauf zu stillen Fehlern führen.

FAQs

Enthält die API einen integrierten Scheduler?

Nein. Die API gibt Daten auf Anfrage zurück. Für die Einrichtung wiederkehrender Automatisierungen (täglich, wöchentlich, monatlich) auf Ihrer Seite sind Sie selbst verantwortlich.

Warum läuft der Download-Link nach 1 Stunde ab?

Die kurze Gültigkeitsdauer ist eine Sicherheitsmaßnahme zum Schutz Ihrer Daten. Stellen Sie sicher, dass Ihr Arbeitsablauf die Datei sofort nach einer erfolgreichen API-Antwort herunterlädt.

Kann ich die Analytics API ohne das A+ Add-on verwenden?

Nein. A+ ist erforderlich. Wenden Sie sich an unser Customer-Success-Team, um Ihre Optionen zu besprechen. Sie können auch eine Testversion anfordern, um das Add-on kennenzulernen.

Die Daten, die ich benötige, werden in meinem Export nicht angezeigt. Was sollte ich prüfen?

Prüfen Sie zuerst, ob das relevante Add-on (User Status History+ oder Nutzeraktivität) für Ihr Konto aktiv ist. Überprüfen Sie dann Ihren Datumsbereich, die Zeitzone und alle optionalen Filter anhand der Analytics API-Dokumentation.