Motimate: Wie man mit der öffentlichen API Berichte generiert

Zusätzlich zum Austausch von Kursabschlussdaten über die Motimate xAPIunterstützen wir auch die Extraktion von Excel-Dateien aus der Motimate Public API. Diese Excel-Berichte basieren auf Berichtsvorlagen, die zuvor in der Funktion Berichte generieren Funktion unter Einblicke in Motimate erstellt wurden.

Hier sind einige nützliche Informationen, bevor wir loslegen:

Die drei relevanten Motimate Public API-Funktionen sind:

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

Bevor du einen Bericht mit der öffentlichen API erstellst, musst du sicherstellen, dass du bereits eine Berichtsvorlage in Berichte generieren erstellt hast(siehe Anleitung hier) und weißt, aus welcher Vorlage du einen oder mehrere Berichte erstellen willst. Wenn das fertig ist, sind drei Schritte erforderlich, um einen Bericht zu erstellen:

Schritt 1: Hol dir eine Liste mit Berichtsvorlagen:

Befehl: GET /insights/learnings/report_templates

Beispielantwort:

{
  "Daten": [
    {
      **"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"
      }
    }
  ]
}

Notiere dir die Vorlagen-ID, die du im nächsten Schritt verwenden musst, in diesem Fall: abc86b82-029a-4b74-9690-4ab607f3eafe

Schritt 2: Erstelle einen neuen Bericht auf Basis der ausgewählten Vorlage

Befehl: POST /insights/learnings/report_requests

In diesem Beispiel musst du abc86b82-029a-4b74-9690-4ab607f3eafe als template_id in dieser Anfrage angeben.

Beispielantwort:

{
  "Daten": {
    **"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"
    }
  }
}

Bitte beachte, dass ein Wert für url noch nicht verfügbar ist. Je nachdem, wie viele Daten in den Bericht einfließen, kann es mehrere Minuten dauern, einen Bericht zu erstellen. Im nächsten Schritt forderst du die Url deines Berichts an.

Schritt 3: URL der Excel-Berichtsdatei abrufen

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

Achte darauf, dass du in der Antwort aus Schritt 2 die ID für die Daten verwendest und nicht die ID für die Vorlage!

Beispielantwort:

{
  "Daten": {
    "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"
    }
  }
}

Möglicherweise musst du diese Anfrage alle 30 Sekunden wiederholen, bis du eine Antwort mit einem Wert für url erhältst. Wie lange das dauert, hängt davon ab, wie viele Daten für die Erstellung des Berichts benötigt werden.

In diesem Beispiel lautet die 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

Wenn du diese URL aufrufst, kannst du deine Berichte in einer Excel-Datei im Format .xlxs herunterladen. Es ist derzeit nicht möglich, die Daten in anderen Dateiformaten zu extrahieren, wie z. B. .csv.

Bitte beachte: Die Datei läuft nach 10 Minuten ab und muss vorher heruntergeladen werden.

ℹ️ Wenn eine Berichtsvorlage von einem Gruppenadministrator erstellt wurde, der nur begrenzten Zugriff auf die Daten ausgewählter Gruppen und Benutzer hat, bleibt diese Einschränkung auch bei der Verwendung der öffentlichen API von Motimate bestehen.