Memotivasi: Cara Membuat Laporan menggunakan API Publik

Selain berbagi data penyelesaian kursus melalui Motimate xAPIkami juga mendukung ekstraksi file Excel dari API Publik Motimate. Laporan Excel ini didasarkan pada templat Laporan yang sebelumnya telah dibuat di bagian Buat Laporan pada fitur Wawasan di Motimate.

Berikut adalah beberapa informasi yang berguna sebelum kita mulai:

Tiga fungsi API Publik Motimate yang relevan adalah:

• GET /insights/pembelajaran/laporan_templat
   
• POST /wawasan/pembelajaran/permintaan_laporan
   
• DAPATKAN /insights/learnings/report_requests/{id}

Sebelum membuat laporan dengan API Publik, pastikan template laporan telah dibuat di Generate Reports(lihat panduan di sini), dan Anda tahu dari template mana Anda akan membuat laporan. Jika ini sudah siap, proses pembuatan laporan akan memerlukan tiga langkah:

Langkah 1: Dapatkan daftar templat laporan:

Perintah: GET /insights/learnings/report_templates

Contoh Tanggapan:

{
  "data": [
    {
      ** "id": "abc86b82-029a-4b74-9690-4ab607f3eafe "**,
      "name": "Report Test",
      "description": "Pengujian untuk tujuan API Publik",
      "status_terakhir": "mengunggah",
      "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": {
        "nama": "John Doe"
      }
    }
  ]
}

Catatlah id templat yang perlu Anda gunakan di langkah berikutnya, dalam hal ini: abc86b82-029a-4b74-9690-4ab607f3eafe

Langkah 2: Buat laporan baru berdasarkan templat yang dipilih

Perintah POST /wawasan/pembelajaran/permintaan_laporan

Dalam contoh ini, pastikan untuk mengirimkan abc86b82-029a-4b74-9690-4ab607f3eafe sebagai template_id dalam permintaan ini.

Contoh Tanggapan:

{
  "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": "Pengujian untuk tujuan API Publik",
      "created_at": "2022-03-01T15:36:42.99789+01:00",
      "updated_at": "2022-03-03T09:48:46.06885+01:00"
    }
  }
}

Harap dicatat bahwa nilai untuk url belum tersedia. Tergantung pada seberapa banyak data yang masuk ke dalam laporan, mungkin diperlukan beberapa menit untuk menghasilkan laporan. Anda akan meminta url laporan Anda di langkah berikutnya.

Langkah 3: Dapatkan URL file laporan Excel

Perintah GET /insights/learnings/report_requests/{id}

Pastikan Anda menggunakan id untuk data dalam respons dari langkah 2, dan bukan id untuk templat!

Contoh Tanggapan:

{
  "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": "Pengujian untuk tujuan API Publik",
      "created_at": "2022-03-01T15:36:42.99789+01:00",
      "updated_at": "2022-03-03T09:48:46.70689+01:00"
    }
  }
}

Anda mungkin perlu menjalankan permintaan ini secara berulang setiap 30 detik hingga Anda mendapatkan respons yang menyertakan nilai url. Berapa lama waktu yang dibutuhkan tergantung pada berapa banyak data yang diperlukan untuk menghasilkan laporan.

Dalam contoh ini, url-nya adalah 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

Mengakses URL ini akan mengunduh laporan Anda dalam file Excel .xlxs. Saat ini tidak memungkinkan untuk mengekstrak data dalam format file lain, seperti misalnya .csv.

Harap diperhatikan: File akan kedaluwarsa setelah 10 menit, dan harus diunduh sebelum itu.

ℹ️ Jika templat laporan telah dibuat oleh Admin Grup, yang hanya memiliki akses terbatas ke data pada Grup dan Pengguna yang dipilih, pembatasan ini akan tetap berlaku ketika menggunakan API Publik Motimate.