Motimate: Cómo generar informes utilizando la API pública

Además de compartir los datos de finalización del curso a través de Motimate xAPItambién podemos extraer archivos Excel de la API pública de Motimate. Estos informes de Excel se basan en plantillas de Informes que se han creado previamente en la opción Generar Informes en Insights de Motimate.

Aquí tienes información útil antes de empezar:

Las tres funciones relevantes de la API Pública de Motimate son:

• GET /insights/aprendizajes/plantillas_de_informe
   
• POST /insights/aprendizajes/solicitudes_de_informe
   
• GET /insights/learnings/report_requests/{id}

Antes de generar un informe con la API Pública, asegúrate de que ya se ha generado una plantilla de informe en Generar Informes(consulta la guía aquí), y de que sabes a partir de qué plantilla(s) vas a generar informe(s). Siempre que esto esté listo, el proceso para generar un informe requerirá tres pasos:

Paso 1: Obtén una lista de plantillas de informes:

Comando: GET /insights/aprendizajes/plantillas_informe

Ejemplo de respuesta:

{
  "datos": [
    {
      **"id": "abc86b82-029a-4b74-9690-4ab607f3eafe "**,
      "name": "Prueba de informe",
      "description": "Prueba a efectos de la API pública",
      "last_status": "cargando",
      "last_generated_at": null,
      "created_at": "2022-03-01T15:36:42.99789+01:00",
      "updated_at": "2022-03-01T15:41:26.98349+01:00",
      "usuario": {
        "nombre": "John Doe"
      }
    }
  ]
}

Anota el id de la plantilla que deberás utilizar en el siguiente paso, en este caso: abc86b82-029a-4b74-9690-4ab607f3eafe

Paso 2: Generar un nuevo informe basado en la plantilla seleccionada

Comando: POST /insights/aprendizajes/solicitudes_de_informe

En este ejemplo, asegúrate de enviar abc86b82-029a-4b74-9690-4ab607f3eafe como template_id en esta solicitud.

Ejemplo de respuesta:

{
  "datos": {
    **"id": "abc23922-940d-4d6d-a6f0-ecaed00810c4"**,
    "status": "iniciado",
    "fecha_creación": "2022-03-03T08:48:46.051Z",
    "updated_at": "2022-03-03T08:48:46.051Z",
    "url": null,
    "template": {
      "id": "abc86b82-029a-4b74-9690-4ab607f3eafe",
      "name": "Prueba de informe",
      "description": "Prueba con fines de API pública",
      "created_at": "2022-03-01T15:36:42.99789+01:00",
      "updated_at": "2022-03-03T09:48:46.06885+01:00"
    }
  }
}

Ten en cuenta que aún no está disponible un valor para url. Dependiendo de la cantidad de datos que se incluyan en el informe, puede llevar varios minutos generarlo. En el siguiente paso solicitarás la url de tu informe.

Paso 3: Obtener la URL del archivo de informe de Excel

Comando: GET /insights/learnings/report_requests/{id}

Asegúrate de utilizar el identificador de los datos en la respuesta del paso 2, ¡y no el identificador de la plantilla!

Ejemplo de respuesta:

{
  "datos": {
    "id": "abc23922-940d-4d6d-a6f0-ecaed00810c4",
    "status": "hecho",
    "created_at": "2022-03-03T08:48:46.051Z",
    "updated_at": "2022-03-03T08:48:46.839Z",
    **"url": "<https://motimate-reports-production.s3.eu-west-1.amazonaws.com/abc883af5017bcb49a6b99e71b01a0660b8f5204/report-test_1646297326.xlsx?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ABCAYLEQ6WVKO52OZP5X%2F20220303%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20220303T085426Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=abc3806250e855b83fc121ea181764cc6df64481c63371004a27229acbaf98de>"**,
    "plantilla": {
      "id": "abc86b82-029a-4b74-9690-4ab607f3eafe",
      "name": "Prueba de informe",
      "description": "Prueba con fines de API pública",
      "created_at": "2022-03-01T15:36:42.99789+01:00",
      "updated_at": "2022-03-03T09:48:46.70689+01:00"
    }
  }
}

Puede que tengas que ejecutar esta petición de forma recurrente cada 30 segundos hasta que obtengas una respuesta que incluya un valor para url. El tiempo que se tarde dependerá de cuántos datos se necesiten para generar el informe.

En este ejemplo la url es https://motimate-reports-production.s3.eu-west-1.amazonaws.com/abc883af5017bcb49a6b99e71b01a0660b8f5204/report-test_1646297326.xlsx?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ABCAYLEQ6WVKO52OZP5X%2F20220303%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20220303T085426Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=abc3806250e855b83fc121ea181764cc6df64481c63371004a27229acbaf98de

Accediendo a esta URL descargarás tus informes en un archivo Excel .xlxs. Actualmente no es posible extraer los datos en otros formatos de archivo, como por ejemplo .csv.

Nota: El archivo caducará a los 10 minutos, por lo que debes descargarlo antes.

ℹ️ Si una plantilla de informe ha sido creada por un Administrador de Grupo, que sólo tiene acceso limitado a los datos de Grupos y Usuarios seleccionados, esta restricción seguirá vigente cuando utilices la API Pública de Motimate.