Motimate: Jak generować raporty za pomocą publicznego interfejsu API

Oprócz udostępniania danych o ukończeniu kursu za pośrednictwem Motimate xAPIwspieramy również wyodrębnianie plików Excel z Motimate Public API. Te raporty Excel są oparte na szablonach raportów, które zostały wcześniej utworzone w aplikacji Generuj raporty w sekcji Wnioski w aplikacji Motimate.

Oto kilka przydatnych informacji, zanim zaczniemy:

Trzy odpowiednie funkcje Motimate Public API to:

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

Przed wygenerowaniem raportu za pomocą publicznego interfejsu API upewnij się, że szablon raportu został już wygenerowany w Generuj raporty(zobacz przewodnik tutaj) i wiesz, z którego szablonu (szablonów) będziesz generować raport (raporty). Jeśli wszystko jest gotowe, proces generowania raportu będzie wymagał trzech kroków:

Krok 1: Pobierz listę szablonów raportów:

Polecenie: GET /insights/learnings/report_templates

Przykładowa odpowiedź:

{
  "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"
      }
    }
  ]
}

Zanotuj identyfikator szablonu, którego będziesz musiał użyć w następnym kroku, w tym przypadku: abc86b82-029a-4b74-9690-4ab607f3eafe.

Krok 2: Wygeneruj nowy raport na podstawie wybranego szablonu

Polecenie: POST /insights/learnings/report_requests

W tym przykładzie upewnij się, że podałeś abc86b82-029a-4b74-9690-4ab607f3eafe jako template_id w tym żądaniu.

Przykładowa odpowiedź:

{
  "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": "Testowanie na potrzeby publicznego API",
      "created_at": "2022-03-01T15:36:42.99789+01:00",
      "updated_at": "2022-03-03T09:48:46.06885+01:00"
    }
  }
}

Zwróć uwagę, że wartość url nie jest jeszcze dostępna. W zależności od ilości danych zawartych w raporcie, jego wygenerowanie może zająć kilka minut. W następnym kroku poprosisz o adres URL raportu.

Krok 3: Uzyskaj adres URL pliku raportu Excel

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

Upewnij się, że używasz identyfikatora danych w odpowiedzi z kroku 2, a nie identyfikatora szablonu!

Przykładowa odpowiedź:

{
  "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": "Testowanie na potrzeby publicznego API",
      "created_at": "2022-03-01T15:36:42.99789+01:00",
      "updated_at": "2022-03-03T09:48:46.70689+01:00"
    }
  }
}

Być może będziesz musiał uruchamiać to żądanie cyklicznie co 30 sekund, aż otrzymasz odpowiedź zawierającą wartość url. To, jak długo to potrwa, zależy od ilości danych wymaganych do wygenerowania raportu.

W tym przykładzie adres url to 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

Uzyskanie dostępu do tego adresu URL spowoduje pobranie raportów w pliku Excel .xlxs. Obecnie nie jest możliwe wyodrębnienie danych w innych formatach plików, takich jak na przykład .csv.

Uwaga: plik wygaśnie po 10 minutach i musi zostać pobrany przed upływem tego czasu.

ℹ️ Jeśli szablon raportu został utworzony przez administratora grupy, który ma ograniczony dostęp do danych wybranych grup i użytkowników, ograniczenie to będzie nadal obowiązywać podczas korzystania z Motimate Public API.