APIs für die Datenextraktion

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

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

Weitere Informationen zu Domänen und URLs finden Sie unter Erste Schritte im 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 Sie beginnen

Bevor Sie mit der Nutzung der Geschäftsdaten-API beginnen können, müssen Sie Berechtigungen einrichten, und einen Zugriffsschlüssel generieren sowie den Registrierungs- und Authentifizierungsprozess befolgen, der im Entwicklerportal erklärt wird. Erforderliche Berechtigungen:

  • Entität:

    • Wenn Sie Interaktionsmetadaten extrahieren möchten, benötigen Sie die Berechtigung Suche & Wiedergabe > APIs > Interaktionsmetadaten extrahieren.

    • Wenn Sie QMWorkflowdaten extrahieren, benötigen Sie die Berechtigung QM-Tools > Datenextraktions-APIs > QM-Workflow-API.

    • Wenn Sie QMQ&A-Daten extrahieren, dann benötigen Sie die Berechtigung QM-Werkzeuge > Datenextraktions-APIs > QM-Workflow-API .

    • Wenn Sie WFM Payroll-Daten extrahieren, benötigen Sie die Berechtigung WFM > Datenextrahierung-APIs > WFM Payroll API .

GET 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 Arbeitsablauf-API können Sie QM-Arbeitsablaufdaten extrahieren, einschließlich Bewertungen, Selbstbewertungen und Kalibrierungen.

Für den POST-Job:

  • entityName ist: qm-workflows

  • Version ist: 4

Die Daten werden entsprechend Einreichungsdatum gefiltert (in UTC).

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

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

Für den POST-Job:

  • entityName ist: qm-questions

  • Version ist: 2

Die Daten werden entsprechend Einreichungsdatum gefiltert (in UTC).

QM-Bewerteranmerkungen und CSV-Datei

Mit der QM-Bewerteranmerkungen-API können Sie Anmerkungen von QM-Bewertern extrahieren.

Für den POST-Job:

  • entityName ist: qm-evaluation-comment-entity

  • version ist: 1

Die Daten werden entsprechend Einreichungsdatum gefiltert (in UTC).

Interaktionsmetadaten-Entität und CSV-Datei

Mit der Interaktionsmetadaten-API können Sie Recording Interaktionsmetadaten extrahieren.

Für den POST-Job:

  • entityName ist: recording-interaction-metadata

  • Version ist: 7

  • Um Daten nach Datum und Uhrzeit zu filtern, verwenden Sie startDate und endDate in UTC im Format jjjj-mm-tt hh:mm:ss

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. Beachten Sie, dass die Zeitzone für Datum und Uhrzeit der Zeitzone des Terminplaners entspricht.