Geplante Exporte über die Analytics API

Mit der Analytics API, die Kunden mit Analytics+ zur Verfügung steht, können Sie Anruf- und Nutzermetriken direkt in Ihre eigenen Reporting-Tools übertragen, ohne Daten manuell aus dem Aircall Dashboard zu exportieren. Sie können wiederkehrende Exporte täglich, wöchentlich oder monatlich automatisieren und anhand der Daten benutzerdefinierte, auf Ihr Unternehmen zugeschnittene Berichte erstellen.

Dieser Artikel erläutert, was die Analytics API bietet, wie sie funktioniert und was beim Einrichten automatisierter Exporte zu beachten ist.

Achtung: Die Analytics API steht ausschließlich Kunden mit dem Analytics+ Add-on zur Verfügung. Wenn Sie nicht sicher sind, ob Ihr Tarif Analytics+ umfasst, wenden Sie sich an das Customer-Success-Team.

Exportierbare Daten

Über die API können Sie auf drei Datenkategorien zugreifen:

• Verlauf: Detaillierte Datensätze zu eingehenden und ausgehenden Anrufen.
• User Status History+: Ein zeitlicher Verlauf des Verfügbarkeitsstatus von Mitarbeitenden.
• Nutzeraktivität: Eine Reihe von Leistungskennzahlen pro Nutzer:in, darunter Anrufvolumen, Gesprächszeit, Bearbeitungszeit nach jedem Anruf, Klingelversuche und die in jedem Status verbrachte Zeit.

Jede Kategorie entspricht den Berichten, die in Ihrem Aircall Dashboard verfügbar sind. Eine vollständige Liste der exportierbaren Berichte und der zugehörigen API-Parameterwerte finden Sie in der Dokumentation zur Analytics API.

Erste Schritte: API-Schlüssel erstellen

Für die Nutzung der Analytics API benötigen Sie einen API-Schlüssel. Dieser Schlüssel identifiziert Ihr Konto und autorisiert Ihre Anfragen. API-Schlüssel können direkt im Aircall Dashboard erstellt und verwaltet werden.

Achtung: Ihr geheimer API-Token wird nur einmal direkt nach der Erstellung angezeigt. Kopieren und speichern Sie ihn an einem sicheren Ort, bevor Sie die Seite verlassen, da er später nicht erneut abgerufen werden kann.

Schritte:

1. Gehen Sie zu Aircall Dashboard > Integrationen > API-Schlüssel.
2. Klicken Sie unter der Tabelle „API-Schlüssel“ auf API-Schlüssel erstellen.
3. Geben Sie Ihrem Schlüssel einen leicht erkennbaren Namen, beispielsweise den Namen des Tools oder Skripts, das ihn verwenden wird.
4. Kopieren Sie den geheimen API-Token und speichern Sie ihn an einem sicheren Ort.

Ihr Schlüssel wird anschließend in der Liste der API-Schlüssel angezeigt. Übergeben Sie den geheimen Token im Autorisierungs-Header Ihrer API-Anfragen. Ausführliche technische Informationen finden Sie in der Dokumentation zur Analytics API.

Funktionsweise eines Exports

Exporte über die Analytics API erfolgen in einem einfachen dreistufigen Prozess. Die Daten werden asynchron vorbereitet. Das bedeutet, dass die Datei im Hintergrund erstellt und nicht sofort zurückgegeben wird.

1. Export anfordern. Geben Sie den gewünschten Bericht und den Datumsbereich an. Die API gibt eine eindeutige Export-ID zurück.
2. Verfügbarkeit prüfen. Prüfen Sie anhand der Export-ID den Status Ihrer Anfrage. Sobald der Status als abgeschlossen angezeigt wird, ist Ihre Datei verfügbar.
3. CSV-Datei herunterladen. Rufen Sie den Download-Link aus der Statusantwort ab und laden Sie Ihre Datei herunter.

Der gesamte Vorgang dauert je nach Datumsbereich und Datenmenge normalerweise einige Sekunden bis wenige Minuten.

Achtung: Der Download-Link läuft 1 Stunde nach seiner Erstellung ab. Laden Sie Ihre Datei herunter, sobald sie verfügbar ist.

Filter und Datumsbereiche

Für jede API-Anfrage sind die folgenden Parameter erforderlich:

• Berichtstyp: Der konkrete Bericht, den Sie exportieren möchten. Die vollständige Liste finden Sie in der Dokumentation zur Analytics API.
• Datumsbereich: Der Zeitraum, den der Export abdecken soll.
• Zeitzone: Die auf die Daten angewendete Zeitzone. Wenn keine Zeitzone angegeben ist, wird standardmäßig UTC verwendet.

Sie können auch optionale Filter übergeben, um die Ergebnisse einzugrenzen. Diese entsprechen den Filtern, die für den jeweiligen Bericht im Aircall Dashboard verfügbar sind. Die verfügbaren optionalen Filter unterscheiden sich je nach Berichtstyp. Eine vollständige Liste für jeden Bericht finden Sie in der Dokumentation zur Analytics API.

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

Datenaufbewahrung

Die exportierten Daten decken denselben Zeitraum ab, der im Aircall Dashboard sichtbar ist:

Best Practices

Die folgenden Empfehlungen gelten sowohl für einmalige Exporte als auch für den Aufbau einer vollständig automatisierten Pipeline.

Zeitplanung in Ihrem System 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 Spitzenzeiten planen

Lösen Sie automatisierte Exporte nach Möglichkeit außerhalb der Geschäftszeiten aus. Dadurch sinkt das Risiko von Verzögerungen bei hoher API-Auslastung und eine konsistente Datenverfügbarkeit wird unterstützt.

Nach jeder Anfrage sofort herunterladen

Der Download-Link läuft nach 1 Stunde ab. Konfigurieren Sie Ihre Automatisierung so, dass die Datei direkt nach Eingang der API-Antwort heruntergeladen wird, statt den Link für einen späteren Abruf zu speichern.

Zeilenlimits des Zielsystems prüfen

Die API legt kein Zeilenlimit für Exporte fest. Einige Importtools und Tabellenkalkulationsprogramme begrenzen jedoch die Anzahl der Zeilen, die sie verarbeiten können. Prüfen Sie die Limits Ihres Zielsystems, bevor Sie umfangreiche 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 fehlerhafte Parameter frühzeitig erkennen, bevor sie in einem automatisierten Arbeitsablauf unbemerkte Fehler verursachen.

Häufig gestellte Fragen

Enthält die API eine integrierte Zeitplanung?

Nein. Die API gibt Daten auf Anfrage zurück. Sie sind dafür verantwortlich, wiederkehrende Automatisierungen (täglich, wöchentlich, monatlich) in Ihrem System 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 Arbeitsablauf die Datei unmittelbar 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 auszuprobieren.

Die benötigten Daten werden in meinem Export nicht angezeigt. Was sollte ich überprüfen?

Vergewissern Sie sich zunächst, dass das Analytics+-Add-on für Ihr Konto aktiviert ist. Überprüfen Sie dann den Datumsbereich, die Zeitzone und alle optionalen Filter anhand der Dokumentation zur Analytics API.

Kann ich Exporte nach Nutzer:in oder Team filtern?

Die meisten Berichte unterstützen optionale Filter. Die für die einzelnen Berichte verfügbaren Parameter finden Sie in der Dokumentation zur Analytics API.

Gibt es bei Exporten eine Zeilenbegrenzung?

Die API selbst legt keine Zeilenbegrenzung fest. Beachten Sie, dass Ihr Zieltool eigene Importbeschränkungen haben kann.