Die Analytics API, verfügbar für Analytics+-Kund:innen, ermöglicht es Ihnen, Anruf- und Nutzermetriken direkt in Ihre eigenen Reporting-Tools zu ziehen, ohne Daten manuell aus dem Aircall Dashboard zu exportieren. 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 Kund:innen mit dem Analytics+-Add-on verfügbar. Wenn Sie nicht sicher sind, ob Ihr Tarif Analytics+ enthält, kontaktieren Sie 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 Agent:innen im Zeitverlauf.
- Nutzeraktivität: Eine Reihe von Leistungskennzahlen pro Nutzer:in, einschließlich Anrufvolumen, Zeit im Gespräch, Bearbeitungszeit nach jedem Anruf, Klingelversuchen und der in jedem Status verbrachten Zeit.
Jede Kategorie entspricht den Berichten, die in Ihrem Aircall Dashboard verfügbar sind. Die vollständige Liste der exportierbaren Berichte und ihrer entsprechenden API-Parameterwerte finden Sie in der Analytics API-Dokumentation.
Erste Schritte: Einen API-Schlüssel generieren
Um die Analytics API zu verwenden, benötigen Sie einen API-Schlüssel. Dieser Schlüssel identifiziert Ihr Konto und autorisiert Ihre Anfragen. Sie erstellen und verwalten API-Schlüssel direkt im Aircall-Dashboard.
ACHTUNG: Ihr geheimer API-Token wird nur einmal angezeigt, direkt nachdem Sie ihn erstellt haben. Kopieren Sie ihn und speichern Sie ihn sicher, bevor Sie die Seite verlassen, da er später nicht erneut abgerufen werden kann.
Schritte:
- Gehen Sie zu Aircall Dashboard > Integrationen & API > API-Schlüssel.
- Klicken Sie unterhalb der Tabelle API-Schlüssel auf Einen API-Schlüssel generieren.
- Geben Sie Ihrem Schlüssel einen gut erkennbaren Namen (zum Beispiel den Namen des Tools oder Skripts, das ihn verwenden wird).
- Kopieren Sie den geheimen API-Token und speichern Sie ihn an einem sicheren Ort.
Ihr Schlüssel wird dann in der Liste der API-Schlüssel angezeigt. Übergeben Sie den geheimen Token im Autorisierungs-Header Ihrer API-Anfragen. Vollständige technische Details finden Sie in der Analytics API-Dokumentation.
So funktioniert ein Export
Exporte aus der Analytics API folgen einem einfachen dreistufigen Prozess. Die Daten werden asynchron vorbereitet, das heißt, die Datei wird im Hintergrund erstellt, anstatt sofort zurückgegeben zu werden.
- Export anfordern. Geben Sie an, welchen Bericht Sie möchten und welchen Datumsbereich Sie benötigen. Die API gibt eine eindeutige Export-ID zurück.
- Prüfen, wann er bereit ist. Verwenden Sie die Export-ID, um den Status Ihrer Anfrage zu prüfen. Sobald der Status als abgeschlossen angezeigt wird, ist Ihre Datei bereit.
- CSV herunterladen. Rufen Sie den Download-Link aus der Statusantwort ab und laden Sie Ihre Datei herunter.
Der gesamte Prozess dauert in der Regel einige Sekunden bis einige Minuten, abhängig vom Datumsbereich und dem Datenvolumen.
ACHTUNG: Der Download-Link läuft 1 Stunde nach seiner Generierung ab. Laden Sie Ihre Datei herunter, sobald sie bereit ist.
Filter und Datumsbereiche
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 wird UTC verwendet, wenn nichts angegeben ist.
Sie können auch optionale Filter übergeben, um die Ergebnisse einzugrenzen. Diese entsprechen den Filtern, die für jeden Bericht im Aircall-Dashboard verfügbar sind. Die verfügbaren optionalen Filter unterscheiden sich je nach Berichtstyp. Die vollständige Liste pro Bericht finden Sie in der Analytics API-Dokumentation.
ACHTUNG: Anfragen ohne einen Pflichtparameter schlagen fehl. Testen Sie jeden Berichtstyp mit allen erforderlichen Parametern, bevor Sie automatisierte Exporte planen.
Datenaufbewahrung
Exportierte Daten decken denselben Zeitraum ab wie die Daten, die im Aircall Dashboard sichtbar sind:
| Berichtsbereich | Aufbewahrungszeitraum |
|---|---|
| Verlauf | 6 Monate |
| User Status History+ | 7 Tage |
| Nutzeraktivität | Unbegrenzt |
Best Practices
Die folgenden Empfehlungen gelten unabhängig davon, ob Sie einmalige Exporte ausführen oder eine vollständig automatisierte Pipeline aufbauen.
Planung auf Ihrer Seite einrichten
Die API plant Exporte nicht automatisch. Wenn Exporte täglich, wöchentlich oder monatlich ausgeführt werden sollen, müssen Sie dies in Ihrem eigenen System oder Automatisierungstool einrichten.
Exporte außerhalb der Geschäftszeiten planen
Lösen Sie automatisierte Exporte nach Möglichkeit außerhalb der Geschäftszeiten aus. Das verringert das Risiko von Verzögerungen in Zeiten hoher API-Auslastung und hilft, eine konsistente Datenverfügbarkeit sicherzustellen.
Unmittelbar nach jeder Anfrage herunterladen
Der Download-Link läuft nach 1 Stunde ab. Richten Sie Ihre Automatisierung so ein, dass die Datei heruntergeladen wird, sobald die API-Antwort eingeht, 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 Produktion ausführen.
Testen, bevor Sie automatisieren
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 Workflow zu stillen Fehlern führen.
FAQs
Enthält die API einen integrierten Scheduler?
Nein. Die API gibt Daten auf Anfrage zurück. Sie sind selbst dafür verantwortlich, wiederkehrende Automatisierungen (täglich, wöchentlich, monatlich) auf Ihrer Seite einzurichten.
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 Workflow die Datei direkt nach einer erfolgreichen API-Antwort herunterlädt.
In welchem Dateiformat werden Exporte bereitgestellt?
Alle Exporte werden als CSV-Dateien bereitgestellt.
Kann ich die Analytics API ohne das Analytics+-Add-on verwenden?
Nein. Analytics+ 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 zu testen.
Die Daten, die ich benötige, werden in meinem Export nicht angezeigt. Was sollte ich prüfen?
Bestätigen Sie zunächst, dass das Analytics+-Add-on für Ihr Konto aktiv ist. Prüfen Sie dann Ihren Datumsbereich, Ihre Zeitzone und alle optionalen Filter anhand der Analytics API-Dokumentation.
Kann ich Exporte nach Nutzer:in oder Team filtern?
Die meisten Berichte unterstützen optionale Filter. In der Analytics API-Dokumentation finden Sie die für jeden Bericht verfügbaren Parameter.
Gibt es ein Zeilenlimit für Exporte?
Die API selbst setzt kein Zeilenlimit. Beachten Sie, dass Ihr Zieltool eigene Importlimits haben kann.