• English
  • Español
  • Portugues
  • Français

API Coremetrix

L' API de rapport Coremetrix facilite la récupération des informations d'essai et des scores. Cette section couvre le processus de consultation de l'API et de vérification de la ressource statut jusqu'à ce que les informations requises soient disponibles..

Remarque : Il existe une section distincte dédiée aux webhooks, intitulée "Webhooks."
api-poling

Le statut de l'essai peut être l'un des suivants :

StatutDescription
INCOMPLETELe quiz n'a pas encore été complété, aucun score ne sera présent
COMPLETED_SCOREDLe quiz a été complété, des scores seront présents pour tous les modèles activés.
COMPLETED_PARTIALLY_SCOREDLe quiz a été complété, des scores seront présents pour certains modèles et des drapeaux seront présents pour d'autres modèles. Notez que tous les questionnaires n'ont pas plusieurs modèles déployés.
COMPLETED_NOT_SCOREDImpossible de noter le quiz, raisons possibles : le quiz a été répondu trop rapidement (aucun profil ne sera généré et un drapeau FAST_CLICK sera présent à la place), aucun modèle n'a été configuré / activé, etc.

Des informations supplémentaires peuvent être déduites en observant les informations de chronométrage :

timestampDescription
landingL'écran d'accueil du quiz a été chargé dans le navigateur, mais l'utilisateur n'a pas progressé davantage.
loadLe quiz a été chargé dans le navigateur mais aucune réponse n'a été soumise
load + startLe quiz a été démarré et au moins une réponse a été soumise
load + start + completeLe quiz a été complété, toutes les réponses ont été soumises

Rapport des tentatives par identifiant personnalisé

L'API peut renvoyer un rapport si nous filtrons par identifiant personnalisé. L'identifiant personnalisé devrait être le même puid utilisé lors de la passation du quiz..

Remarque : Le rapport contiendra la plupart du temps une tentative de quiz car les retours de quiz ne sont pas autorisés dans l'espace de 3 mois.
gethttps://api.coremetrix.com/report/attempts?customId={id}
Sample response
{
  • "customId": "123456789XYZ",
  • "attempts": [
    • {
      • "name": "sandbox",
      • "flags": [ ],
      • "timings": {
        • "landing": 1539084813410,
        • "load": 1539084815550,
        • "start": 1539086050697,
        • "end": 1539086175830
        },
      • "id": "ee1a392f-eccc-4f54-bd72-993e11ddde13",
      • "status": "COMPLETED_SCORED",
      • "quizId": "63f751bb-7a2b-4c86-bfbc-217c1104b36e",
      • "scores": [
        • {
          • "value": 248.25117341335454,
          • "model": "sandbox"
          }
        ],
      • "user": {
        • "accommodation": "Private housing",
        • "age": "20-24",
        • "education": "BSc",
        • "maritalStatus": "Single",
        • "occupation": "Self-employed"
        }
      }
    ]
}

Tentative par identifiant de tentative

L'API peut renvoyer une tentative par identifiant.

gethttps://api.coremetrix.com/report/attempts/{attemptId}
Sample response
{
  • "name": "sandbox",
  • "flags": [ ],
  • "timings": {
    • "landing": 1539084813410,
    • "load": 1539084815550,
    • "start": 1539086050697,
    • "end": 1539086175830
    },
  • "clientInfo": {},
  • "id": "ee1a392f-eccc-4f54-bd72-993e11ddde13",
  • "status": "COMPLETED_SCORED",
  • "quizId": "63f751bb-7a2b-4c86-bfbc-217c1104b36e",
  • "scores": [
    • {
      • "value": 248.25117341335454,
      • "model": "sandbox"
      }
    ],
  • "user": {
    • "accommodation": "Private housing",
    • "age": "20-24",
    • "education": "BSc",
    • "maritalStatus": "Single",
    • "occupation": "Self-employed"
    }
}

Rapport des tentatives en lot (7 jours)

Les rapports peuvent être filtrés par quizId et une plage de dates. quizId, from et to les paramètres de requête sont facultatifs. Les dates sont au format ISO8601, si les dates ne sont pas fournies alors to par défaut à la date et l'heure actuelles, et from par défaut à sept jours plus tôt que to. La différence maximale entre from et to ne peut pas être supérieure à 7 jours.

Remarque :

Les tentatives de test sont filtrées par défaut mais peuvent être explicitement rendues disponibles par le includeTest

Remarque : /report/attempts?quizId=63f751bb-7a2b-4c86-bfbc-217c1104b36e&from=2019-07-01T00:00:01Z&to=2019-07-05T16:01:02Z&includeTest=true

gethttps://api.coremetrix.com/report/attempts
Sample response
{
  • "results": [
    • {
      • "customId": "a5b7c1e5-460f-45e2",
      • "attempts": [
        • {
          • "name": "   sandbox",
          • "flags": [ ],
          • "timings": {
            • "load": 1562226135859
            },
          • "id": "05a50ee4-4ffa-45a1-b01d-b043e31cfc41",
          • "status": "INCOMPLETE",
          • "quizId": "63f751bb-7a2b-4c86-bfbc-217c1104b36e",
          • "scores": [ ]
          }
        ]
      },
    • {
      • "customId": "b28acd4b-0755-4417",
      • "attempts": [
        • {
          • "name": "sandbox",
          • "flags": [ ],
          • "timings": {
            • "landing": 1539084813410,
            • "load": 1562225934584,
            • "start": 1562225937347,
            • "end": 1562225956220
            },
          • "id": "730b9c99-5c68-459b-b583-d96743cfe03f",
          • "status": "COMPLETED_SCORED",
          • "quizId": "63f751bb-7a2b-4c86-bfbc-217c1104b36e",
          • "scores": [
            • {
              • "value": 256.67901827947344,
              • "model": "sandbox"
              }
            ],
          • "user": {
            • "accommodation": "Private housing",
            • "age": "20-24",
            • "education": "BSc",
            • "maritalStatus": "Single",
            • "occupation": "Self-employed"
            }
          }
        ]
      },
    • {
      • "customId": "91fede51-dfcf-4670",
      • "attempts": [
        • {
          • "name": "sandbox",
          • "flags": [ ],
          • "timings": {
            • "landing": 1539084813410,
            • "load": 1562225977118,
            • "start": 1562225978135,
            • "end": 1562225984913
            },
          • "id": "2db0e167-824d-4e78-98ae-a610387cfddf",
          • "status": "COMPLETED_SCORED",
          • "quizId": "63f751bb-7a2b-4c86-bfbc-217c1104b36e",
          • "scores": [
            • {
              • "value": 234.41970196460838,
              • "model": "sandbox"
              }
            ],
          • "user": {
            • "accommodation": "Private housing",
            • "age": "20-24",
            • "education": "BSc",
            • "maritalStatus": "Single",
            • "occupation": "Self-employed"
            }
          }
        ]
      }
    ]
}

L' API de ConsentementConsent API retourne des informations sur le consentement des utilisateurs.

Sample response
{
  • "name": "sandbox",
  • "flags": [ ],
  • "timings": {
    • "landing": 1539084813410,
    • "load": 1539084815550,
    • "start": 1539086050697,
    • "end": 1539086175830
    },
  • "clientInfo": {},
  • "id": "ee1a392f-eccc-4f54-bd72-993e11ddde13",
  • "status": "COMPLETED_SCORED",
  • "quizId": "63f751bb-7a2b-4c86-bfbc-217c1104b36e",
  • "scores": [
    • {
      • "value": 248.25117341335454,
      • "model": "sandbox"
      }
    ],
  • "user": {
    • "accommodation": "Private housing",
    • "age": "20-24",
    • "education": "BSc",
    • "maritalStatus": "Single",
    • "occupation": "Self-employed"
    }
}
RETOUR