Hvordan generere rapporter ved hjelp av Public API?

I tillegg til å dele kursfullføringsdata via Motimate xAPI, støtter vi også uthenting av Excel-filer fra Motimate Public API. Disse Excel-rapportene er basert på rapportmaler som tidligere er opprettet i funksjonen Generer Rapporter under Innsikt i Motimate.

Her er noen nyttige opplysninger før vi starter:

De tre relevante Motimate Public API-funksjonene er:

• GET /insights/learnings/report_templates
  
  
• POST /insights/learnings/report_requests
  
  
• GET /insights/learnings/report_requests/{id}

Før du genererer en rapport med Public API, må du sørge for at en rapportmal allerede er opprettet i Generer Rapporter (se veiledning her), og at du vet hvilken eller hvilke maler rapportene skal genereres fra. Når dette er klart, vil prosessen for å generere en rapport kreve tre trinn:

Trinn 1: Hent en liste over rapportmaler

Kommando: GET /insights/learnings/report_templates

Eksempelrespons:

{
  "data": [
    {
      **"id": "abc86b82-029a-4b74-9690-4ab607f3eafe"**,
      "name": "Report Test",
      "description": "Testing for Public API purpose",
      "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",
      "user": {
        "name": "John Doe"
      }
    }
  ]
}

Noter ned template id, som du trenger til neste trinn, i dette tilfellet: abc86b82-029a-4b74-9690-4ab607f3eafe.

Trinn 2: Generer en ny rapport basert på valgt mal

Kommando: POST /insights/learnings/report_requests

Bruk abc86b82-029a-4b74-9690-4ab607f3eafe som template_id i forespørselen.

Eksempelrespons:

{
  "data": {
    **"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": "Testing for Public API purpose",
      "created_at": "2022-03-01T15:36:42.99789+01:00",
      "updated_at": "2022-03-03T09:48:46.06885+01:00"
    }
  }
}

Merk at verdien for url ennå ikke er tilgjengelig. Avhengig av hvor mye data rapporten inneholder, kan det ta flere minutter å generere en rapport. Du vil hente rapportens URL i neste trinn.

Trinn 3: Hent URL til Excel-rapportfilen

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

Bruk id fra data i responsen fra trinn 2, ikke id fra malen!

Eksempelrespons:

{
  "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": "Testing for Public API purpose",
      "created_at": "2022-03-01T15:36:42.99789+01:00",
      "updated_at": "2022-03-03T09:48:46.70689+01:00"
    }
  }
}

Du må kanskje kjøre denne forespørselen jevnlig, for eksempel hvert 30. sekund, til du får en respons som inkluderer en verdi for url. Hvor lang tid dette tar, avhenger av datamengden som kreves for å generere rapporten.

I dette eksempelet er URL-en:

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

Ved å åpne denne URL-en lastes rapporten ned som en .xlsx Excel-fil. Det er foreløpig ikke mulig å trekke ut data i andre filformater, som for eksempel .csv.

Vær oppmerksom på:

• Filen utløper etter 10 minutter og må lastes ned før dette.
• Rapportmaler er personlige, og en rapportmal vil kun vise data som brukeren som opprettet den selv har tilgang til.