Motimate: Sådan genererer du rapporter ved hjælp af Public API

Ud over at dele data om gennemførte kurser via Motimate xAPIunderstøtter vi også udtræk af Excel-filer fra Motimate Public API. Disse Excel-rapporter er baseret på rapportskabeloner, der tidligere er blevet oprettet i Generer rapporter funktionen under Indsigt i Motimate.

Her er nogle nyttige oplysninger, før vi går i gang:

De tre relevante Motimate Public API-funktioner er:

• GET /indsigt/læring/rapport_skabeloner
   
• POST /insights/learning/report_requests
   
• GET /insights/learnings/report_requests/{id}

Før du genererer en rapport med Public API, skal du sørge for, at der allerede er genereret en rapportskabelon i Generate Reports(se vejledning her), og at du ved, hvilke(n) skabelon(er) du vil generere rapporter fra. Når den er klar, vil processen med at generere en rapport kræve tre trin:

Trin 1: Hent en liste over rapportskabeloner:

Kommando: GET /insights/learnings/report_templates

Eksempel på svar:

{
  "data": [
    {
      **"id": "abc86b82-029a-4b74-9690-4ab607f3eafe"**,
      "name": "Report Test",
      "description": "Test til offentligt API-formål",
      "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"
      }
    }
  ]
}

Notér det skabelon-id, som du skal bruge i næste trin, i dette tilfælde: abc86b82-029a-4b74-9690-4ab607f3eafe

Trin 2: Generer en ny rapport baseret på den valgte skabelon

Kommando: POST /insights/learnings/report_requests

I dette eksempel skal du sørge for at indsende abc86b82-029a-4b74-9690-4ab607f3eafe som template_id i denne anmodning.

Eksempel på svar:

{
  "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": "Test til offentligt API-formål",
      "created_at": "2022-03-01T15:36:42.99789+01:00",
      "updated_at": "2022-03-03T09:48:46.06885+01:00"
    }
  }
}

Bemærk, at der endnu ikke findes en værdi for url. Afhængigt af hvor mange data, der indgår i rapporten, kan det tage flere minutter at generere en rapport. Du vil anmode om url' en til din rapport i næste trin.

Trin 3: Hent URL'en til Excel-rapportfilen

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

Sørg for at bruge id' et for data i svaret fra trin 2, og ikke id' et for skabelonen!

Eksempel på svar:

{
  "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 til offentligt API-formål",
      "created_at": "2022-03-01T15:36:42.99789+01:00",
      "updated_at": "2022-03-03T09:48:46.70689+01:00"
    }
  }
}

Det kan være nødvendigt at køre denne anmodning igen hvert 30. sekund, indtil du får et svar, der indeholder en værdi for url. Hvor lang tid det tager, afhænger af, hvor mange data der skal bruges til at generere rapporten.

I dette eksempel 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 at gå ind på denne URL kan du downloade dine rapporter i en .xlxs Excel-fil. Det er i øjeblikket ikke muligt at udtrække data i andre filformater, som for eksempel .csv.

Bemærk: Filen udløber efter 10 minutter og skal downloades inden da.

ℹ️ Hvis en rapportskabelon er oprettet af en gruppeadministrator, som kun har begrænset adgang til data om udvalgte grupper og brugere, vil denne begrænsning stadig være i kraft, når man bruger Motimate Public API.