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

API de Coremetrix

La API de Informes de Coremetrix facilita la recuperación de información de intentos y puntajes. Esta sección cubre el proceso de sondaje de la API y la verificación del estado del recurso..

Note: Hay una sección separada dedicada a los webhooks, titulada "Webhooks."
api-poling

El estado del intento puede ser uno de los siguientes:

StatusDescription
INCOMPLETEEl cuestionario aún no se ha completado, no se presentarán puntajes.
COMPLETED_SCOREDEl cuestionario ha sido completado, se esperan puntajes presentes para todos los modelos habilitados.
COMPLETED_PARTIALLY_SCOREDEl cuestionario ha sido completado, se esperan puntajes presentes para algunos modelos y marcas presentes para otros modelos. Ten en cuenta que no todos los cuestionarios tienen múltiples modelos implementados.
COMPLETED_NOT_SCOREDNo se puede calificar el cuestionario, razones posibles: el cuestionario se respondió demasiado rápido (no se generará un perfil y en su lugar se presentará una marca de CLIC RÁPIDO), no se han configurado / habilitado modelos, etc.

Se puede deducir información adicional observando la información de tiempo:

timestampDescription
landingLa landing page del cuestionario se ha cargado en el navegador, pero el usuario no ha avanzado más.
loadEl cuestionario se ha cargado en el navegador pero no se ha enviado ninguna respuesta.
load + startEl cuestionario se ha iniciado y se ha enviado al menos una respuesta.
load + start + completeEl cuestionario ha sido completado, se han enviado todas las respuestas.

Informe de intentos por ID personalizado

La API puede devolver un informe si filtramos por ID personalizado. El ID personalizado debe ser el mismo puid utilizado al realizar el cuestionario..

Note: El informe contendrá la mayor parte del tiempo un intento de cuestionario, ya que no se permiten repeticiones de cuestionarios en el espacio de 3 meses.
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"
        }
      }
    ]
}

Intento por ID de intento

:(

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"
    }
}

Informe de intentos por lotes (7 días)

Los informes se pueden filtrar por quizId y un rango de fechas. quizId, from y to los parámetros de consulta son opcionales. Las fechas están en formato ISO8601, si no se proporcionan fechas entonces to se establece por defecto en la fecha y hora actuales, y from se establece por defecto siete días antes que to. La diferencia máxima entre from a to :(

Note:

Los intentos de prueba se filtran de forma predeterminada pero se pueden hacer explícitamente disponibles mediante el parámetro includeTest .

Note: /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"
            }
          }
        ]
      }
    ]
}

La API de ConsentimientoConsent API devuelve información sobre el consentimiento de los usuarios.

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"
    }
}
BACK