Datenextraktion-APIs

Mit den APIs für die Datenextraktion können Sie Daten CXone für externe Berichtszwecke extrahieren. Sie können zum Beispiel QM Workflow-Daten, QM Frage- und Antwortdaten, CXone Recording Interaktions-Metadaten oder WFM Abrechnungsdaten extrahieren. Daten können nur nach dem angegebenen Datumsbereich gefiltert werden.

Die Datenextraktions-APIs sind im DEVone Developer Community Portal verfügbar.

Weitere Informationen zu Domains und URLs finden Sie unter Erste Schritte im DEVone Developer Community Portal.

Beim Aufrufen des Endpunkts /jobs mit der POST-Methode wird jobId zurückgegeben, während die Daten vorbereitet werden. Sie können überprüfen, ob die Daten bereit sind, indem Sie den Dienst vom Endpunkt abfragen /jobs/{jobId} und der Status des Jobs wird zurückgegeben. Wenn der Status success ist, wird auch eine zusätzliche URL zurückgegeben. Die URL ist 30 Sekunden lang verfügbar (ohne die Zeit, die zum Herunterladen der Datei benötigt wird).

Sie können Skripte schreiben, um die API regelmäßig aufzurufen, anstatt die Daten jedes Mal manuell abzurufen. Zu jedem Zeitpunkt kann nur ein Benutzer pro Instanz eine API aufrufen. Sie können die API nur einmal in einem Zeitraum von 30 Sekunden aufrufen.

Bevor du anfängst

Bevor Sie die Datenextraktions-APIs verwenden können, müssen Sie Berechtigungen einrichten und ein Zugriffstoken generieren.

erhalten Jobs

Zeigen Sie eine Liste aller Jobstatus pro Instanz an. Mögliche Status sind Ausgeführt, Erfolgreich, Fehler, Abgebrochen und Abgelaufen.

POST Jobs

Nachdem eine Anforderung zum Extrahieren von Daten gestellt wurde, werden die Daten gesammelt und für die Extraktion vorbereitet. Die Daten sind in S3 24 Stunden lang als CSV-Datei verfügbar. Wenn Sie fertig sind, wird eine Job-ID zurückgegeben.

GET-Jobs nach Job ID

Zeigen Sie den Status für einen bestimmten Job anhand seiner Job-ID an. Wenn ein Auftrag erfolgreich war, wird eine URL für den Zugriff auf die extrahierten Daten zurückgegeben, auf die 30 Sekunden lang zugegriffen werden kann (ohne die Zeit, die zum Herunterladen der Datei benötigt wird). Wenn der Job fehlgeschlagen ist, wird eine Fehlermeldung zurückgegeben. Über den Link kann auf die extrahierten Daten zugegriffen werden. Mögliche Status sind Ausgeführt, Erfolgreich, Fehler, Abgebrochen und Abgelaufen.

QM Workflow-Entität und CSV-Datei

Mit der QM Workflow-API (Version 3) können Sie QM Workflow-Daten extrahieren, einschließlich Bewertungen, Selbstbewertungen und Kalibrierungen.

Der QM Name der Workflow-Entität für den POST-Job lautet: qm-Workflows.

Die Daten werden entsprechend Einreichungsdatum gefiltert (in UTC).

QM Fragen und Antworten (F & A) Entität und CSV-Datei

Die QM Q&A API (Version 1) ermöglicht es Ihnen, die Fragen und Antworten aus QM Bewertungen, Selbstbeurteilungen und Kalibrierungen zu extrahieren.

Der QM Workflow-Entität-Name für den POST-Job lautet: qm-questions.

Die Daten werden entsprechend Einreichungsdatum gefiltert (in UTC).

Interaktionsmetadaten-Entität und CSV-Datei

Mit der Interaktionsmetadaten-API (Version 3) können Sie CXone Recording Interaktionsmetadaten extrahieren.

Der Workflow-Entität-Name für den POST-Job lautet: recording-interaction-metadata.

Die Daten werden entsprechend der Interaktion Datum des Beginns gefiltert (in UTC).

WFM Lohnbuchhaltung Entität und CSV-Datei

Die WFM Payroll API (Version 1) ermöglicht es Ihnen, WFM Aktivitätsdaten für externe Lohnabrechnungsberichte zu extrahieren.

Der WFM Payroll-Entitätsname für den POST-Auftrag lautet: wfm-payroll.

Die Daten werden nach dem Datum des Abrechnungscodes gefiltert. Keep in mind, the time zone for the date and time are according to the scheduling unit's time zone.