API d’extraction de données

Les API d'extraction de données vous permettent d'extraire des données de CXone Mpower à des fins de reporting externe. Par exemple, vous pouvez extraires QM données de flux de travail, QM données de questions et réponses,Recording métadonnées d'interaction ou WFM Données de paie. Les données ne peuvent être filtrées qu'en fonction de la plage de dates spécifiée.

Les API d'extraction de données sont disponibles dans le portail de la communauté des développeurs.

Pour plus d'informations sur les domaines et les URL, consultez la section Mise en route du portail de la communauté des développeurs.

Lors de l'appel du point de terminaison/emplois avec la méthode POST, un jobId est renvoyé pendant la préparation des données. Vous pouvez vérifier si les données sont prêtes en interrogeant le service à partir du point de terminaison / jobs / {jobId}, le statut du travail est renvoyé. Si le statut est Succès, puis une URL supplémentaire est également renvoyée. L'URL sera accessible pendant 30 secondes (sans compter le temps nécessaire pour télécharger le fichier).

Vous pouvez écrire des scripts pour appeler l'API périodiquement au lieu de récupérer les données manuellement à chaque fois. À tout moment, un seul utilisateur par locataire peut appeler une API. Vous ne pouvez appeler l'API qu'une fois toutes les 30 secondes.

Avant de commencer

Avant de commencer à utiliser l’API de données commerciales, vous devez configurer les autorisations utilisateur, générer une clé d’accès et suivre le processus d’enregistrement et authentification présenté sur le portail des développeurs. Autorisations requises :

  • Entité :

    • Si vous extrayez les métadonnées d’interaction, vous devez disposer de l’autorisation Recherche et lecture > API > Extraire les métadonnées d'interaction.

    • Si vous extrayez QMdonnées de flux de travail, alors vous avez besoin duOutils QM > API d'extraction de données > API de flux de travail QM autorisation.

    • Si vous extrayezQMDonnées de questions / réponses, alors vous avez besoin duOutils QM > API d'extraction de données > API de flux de travail QM autorisation.

    • Si vous extrayez WFMDonnées de paie, alors vous avez besoin du WFM > API d'extraction de données > autorisation WFM API de paie.

GET Travaux

Afficher une liste de tous les statuts de travail par locataire. Les statuts possibles sont le Fonctionnement, Réussi,Manqué, Annulé etExpiré.

PUBLIER Emplois

Une fois qu'une demande d'extraction de données est effectuée, les données sont collectées et préparées pour l'extraction. Les données sont disponibles dans S3 sous forme de fichier CSV pendant 24 heures. Une fois terminé, un ID de travail est renvoyé.

OBTENIR Emplois par ID de travail

Afficher le statut d'un travail spécifique par son ID de travail. Si un travail a réussi, une URL pour accéder aux données extraites est renvoyée et est accessible pendant 30 secondes (sans compter le temps nécessaire pour télécharger le fichier). Si le travail a échoué, un message d'erreur est renvoyé. Le lien peut être utilisé pour accéder aux données extraites. Les statuts de travail possibles sontFonctionnement,Réussi,Manqué ,Annulé , etExpiré.

QMEntité de flux de travail et fichier CSV

L’API de flux de travail de QM vous permet d'extraire les données de flux de travail de QM, ce qui inclut les évaluations, les auto-évaluations et les étalonnages.

Pour le travail POST :

  • L’entityName est : qm-workflows

  • La version est : 4

Les données sont filtrées en fonction duDate de soumission (en UTC).

QMEntité Questions et réponses (Q&A) et fichier CSV

L'API Q&A QM vous permet d'extraire les questions et réponses des évaluations QM, des auto-évaluations et des étalonnages.

Pour le travail POST :

  • L’entityName est : qm-questions

  • La version est : 2

Les données sont filtrées en fonction duDate de soumission (en UTC).

Notes de l’évaluateur QM et fichier CSV

L’API Notes de l’évaluateur QM vous permet d’extraire les notes de l’évaluateur QM.

Pour le travail POST :

  • entityName a la valeur : qm-evaluation-comment-entity

  • La version est : 1

Les données sont filtrées en fonction duDate de soumission (en UTC).

Entité de métadonnées d'interaction et fichier CSV

L'API de métadonnées d'interaction vous permet d'extraire Recording métadonnées d'interaction.

Pour le travail POST :

  • L’entityName  : recording-interaction-metadata

  • La version est : 7

  • Pour filtrer les données par date et heure utilisez startDate et endDate au format UTC : aaaa-mm-jj hh:mm:ss

WFM Entité de paie et fichier CSV

Le WFM API de paie (version1) permet d'extraire WFM données d'activité à des fins de reporting externe de la paie.

Le WFM nom de l'entité de paie pour le travail POST est :wfm-paie.

Les données sont filtrées selon Date de code de paie. if it's clear, not need to doc)Gardez à l'esprit que le fuseau horaire de la date et de l'heure correspond au fuseau horaire de l'unité de planification.