Motimate: Come generare report utilizzando l'API pubblica

Oltre a condividere i dati sul completamento dei corsi tramite Motimate xAPIsupportiamo anche l'estrazione di file Excel dall'API pubblica di Motimate. Questi rapporti Excel si basano sui modelli di rapporto creati in precedenza nella sezione Genera rapporti nella sezione Insights di Motimate.

Ecco alcune informazioni utili prima di iniziare:

Le tre funzioni dell'API pubblica di Motimate sono le seguenti:

• GET /insights/learning/report_templates
   
• POST /insights/learning/report_requestri
   
• GET /insights/learning/report_requests/{id}

Prima di generare un report con l'API pubblica, assicurati che sia già stato generato un modello di report in Generate Reports(vedi la guida qui) e che tu sappia da quale/i modello/i genererai il report. Se questo è pronto, il processo di generazione di un report richiederà tre passaggi:

Passo 1: ottenere un elenco di modelli di report:

Comando: GET /insights/learning/report_templates

Esempio di risposta:

{
  "dati": [
    {
      **"id": "abc86b82-029a-4b74-9690-4ab607f3eafe "**,
      "name": "Report Test",
      "description": "Test per l'API pubblica",
      "last_status": "uploading",
      "last_generated_at": null,
      "created_at": "2022-03-01T15:36:42.99789+01:00",
      "updated_at": "2022-03-01T15:41:26.98349+01:00",
      "utente": {
        "name": "John Doe"
      }
    }
  ]
}

Prendi nota dell'id del modello che dovrai utilizzare nel passaggio successivo, in questo caso: abc86b82-029a-4b74-9690-4ab607f3eafe

Passo 2: Generare un nuovo report basato sul modello selezionato

Comando: POST /insights/learning/report_requests

In questo esempio, assicurati di inviare abc86b82-029a-4b74-9690-4ab607f3eafe come template_id nella richiesta.

Esempio di risposta:

{
  "dati": {
    **"id": "abc23922-940d-4d6d-a6f0-ecaed00810c4"**,
    "status": "started",
    "created_at": "2022-03-03T08:48:46.051Z",
    "updated_at": "2022-03-03T08:48:46.051Z",
    "url": null,
    "template": {
      "id": "abc86b82-029a-4b74-9690-4ab607f3eafe",
      "name": "Report Test",
      "description": "Test per finalità API pubbliche",
      "created_at": "2022-03-01T15:36:42.99789+01:00",
      "updated_at": "2022-03-03T09:48:46.06885+01:00"
    }
  }
}

Tieni presente che il valore di url non è ancora disponibile. A seconda della quantità di dati contenuti nel report, possono essere necessari diversi minuti per generare un report. Nella fase successiva richiederai l'url del tuo report.

Passo 3: Ottenere l'URL del file di report di Excel

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

Assicurati di utilizzare l'id dei dati nella risposta del passo 2 e non l'id del modello!

Esempio di risposta:

{
  "data": {
    "id": "abc23922-940d-4d6d-a6f0-ecaed00810c4",
    "status": "done",
    "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>"**,
    "template": {
      "id": "abc86b82-029a-4b74-9690-4ab607f3eafe",
      "name": "Report Test",
      "description": "Test per finalità API pubbliche",
      "created_at": "2022-03-01T15:36:42.99789+01:00",
      "updated_at": "2022-03-03T09:48:46.70689+01:00"
    }
  }
}

Potrebbe essere necessario eseguire questa richiesta in modo ricorrente, ogni 30 secondi, fino a ottenere una risposta che includa un valore per l'url. Il tempo necessario dipende dalla quantità di dati necessari per generare il report.

In questo esempio l'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

Accedendo a questo URL potrai scaricare i tuoi report in un file Excel .xlxs. Attualmente non è possibile estrarre i dati in altri formati di file, come ad esempio .csv.

Nota bene: il file scadrà dopo 10 minuti e deve essere scaricato prima.

ℹ️ Se un modello di report è stato creato da un amministratore di gruppo che ha un accesso limitato ai dati di gruppi e utenti selezionati, questa restrizione sarà ancora valida quando si utilizza Motimate Public API.