Motimate: Cách tạo báo cáo bằng API công khai

Ngoài việc chia sẻ dữ liệu hoàn thành khóa học qua Motimate xAPI, chúng tôi cũng hỗ trợ trích xuất tệp Excel từ Motimate Public API. Các báo cáo Excel này được tạo dựa trên các mẫu báo cáo đã được tạo trước đó trong Tạo báo cáo trong phần Insights của Motimate.

Dưới đây là một số thông tin hữu ích trước khi chúng ta bắt đầu:

Ba hàm API công khai Motimate liên quan là:

• NHẬN /insights/learnings/report_templates
   
• ĐĂNG /insights/learnings/report_requests
   
• NHẬN /insights/learnings/report_requests/{id}

Trước khi tạo báo cáo bằng API công khai, hãy đảm bảo rằng mẫu báo cáo đã được tạo trong phần Tạo Báo Cáo (xem hướng dẫn tại đây) và bạn đã biết mẫu báo cáo nào sẽ được sử dụng để tạo báo cáo. Nếu điều này đã sẵn sàng, quá trình tạo báo cáo sẽ bao gồm ba bước:

Bước 1: Lấy danh sách các mẫu báo cáo:

Lệnh: GET /insights/learnings/report_templates

Ví dụ về phản hồi:

{
  "data": [
    {
      **"id": "abc86b82-029a-4b74-9690-4ab607f3eafe"**,
      "name": "Report Test",
      "description": "Kiểm tra cho mục đích API công khai",
      "last_status": "đang tải lên",
      "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"
      }
    }
  ]
}

Ghi lại ID mẫu mà bạn sẽ cần sử dụng trong bước tiếp theo, trong trường hợp này: abc86b82-029a-4b74-9690-4ab607f3eafe

Bước 2: Tạo báo cáo mới dựa trên mẫu đã chọn.

Lệnh: POST /insights/learnings/report_requests

Trong ví dụ này, hãy đảm bảo nhập abc86b82-029a-4b74-9690-4ab607f3eafe làm template_id trong yêu cầu này.

Ví dụ về phản hồi:

{
  "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": "Kiểm tra cho mục đích API công khai",
      "created_at": "2022-03-01T15:36:42.99789+01:00",
      "updated_at": "2022-03-03T09:48:46.06885+01:00"
    }
  }
}

Lưu ý rằng giá trị cho url hiện chưa có sẵn. Tùy thuộc vào lượng dữ liệu được nhập vào báo cáo, việc tạo báo cáo có thể mất vài phút. Bạn sẽ yêu cầu URL của báo cáo của mình trong bước tiếp theo.

Bước 3: Lấy URL của tệp báo cáo Excel

Lệnh: GET /insights/learnings/report_requests/{id}

Hãy đảm bảo sử dụng ID cho dữ liệu trong phản hồi từ Bước 2, chứ không phải ID cho mẫu!

Ví dụ về phản hồi:

{
  "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": "Kiểm tra cho mục đích API công khai",
      "created_at": "2022-03-01T15:36:42.99789+01:00",
      "updated_at": "2022-03-03T09:48:46.70689+01:00"
    }
  }
}

Bạn có thể cần chạy yêu cầu này định kỳ mỗi 30 giây cho đến khi nhận được phản hồi chứa giá trị cho url. Thời gian thực hiện phụ thuộc vào lượng dữ liệu cần thiết để tạo báo cáo.

Trong ví dụ này, URL là 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

Truy cập vào URL này sẽ tải xuống các báo cáo của bạn dưới dạng tệp Excel .xlxs. Hiện tại, không thể trích xuất dữ liệu dưới các định dạng tệp khác, ví dụ như .csv.

Lưu ý: Tệp sẽ hết hạn sau 10 phút và phải được tải xuống trước thời hạn đó.

ℹ️ Nếu một mẫu báo cáo được tạo bởi Quản trị viên Nhóm, người chỉ có quyền truy cập hạn chế vào dữ liệu của các Nhóm và Người dùng được chọn, thì hạn chế này vẫn sẽ có hiệu lực khi sử dụng Motimate Public API.