Motimate: วิธีสร้างรายงานโดยใช้ Public API

นอกเหนือจากการแบ่งปันข้อมูลการสำเร็จหลักสูตรผ่าน โมทิเมท xAPI, เราสนับสนุนการดึงไฟล์ Excel จาก Motimate Public API ด้วย รายงาน Excel เหล่านี้สร้างขึ้นจากแม่แบบรายงานที่ได้สร้างไว้ก่อนหน้านี้ในสร้างรายงาน ฟีเจอร์ภายใต้Insights ในMotimate

นี่คือข้อมูลที่เป็นประโยชน์ก่อนที่เราจะเริ่มต้น:

ฟังก์ชัน API สาธารณะของ Motimate ที่เกี่ยวข้องทั้งสามคือ:

• รับ /ข้อมูลเชิงลึก/บทเรียน/แม่แบบรายงาน
   
• โพสต์ /ข้อมูลเชิงลึก/การเรียนรู้/คำขอรายงาน
   
• รับ /insights/learnings/report_requests/{id}

ก่อนที่จะสร้างรายงานผ่าน Public API ให้ตรวจสอบให้แน่ใจว่าได้สร้างเทมเพลตรายงานไว้ใน Generate Reports แล้ว (ดูคู่มือที่นี่) และคุณทราบแล้วว่าจะสร้างรายงานจากเทมเพลตใดบ้าง หากสิ่งนี้พร้อมแล้ว กระบวนการในการสร้างรายงานจะต้องมีสามขั้นตอน:

ขั้นตอนที่ 1: รับรายการแม่แบบรายงาน:

คำสั่ง:GET /insights/learnings/report_templates

ตัวอย่างคำตอบ:

{
  "data": [
    {
      **"id": "abc86b82-029a-4b74-9690-4ab607f3eafe"**,
      "name": "รายงานทดสอบ",
      "description":"การทดสอบสำหรับวัตถุประสงค์ของ Public API",
      "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"
      }
    }
  ]
}

โปรดจดบันทึกหมายเลขเทมเพลตที่คุณจะต้องใช้ในขั้นตอนถัดไป ในกรณีนี้:abc86b82-029a-4b74-9690-4ab607f3eafe

ขั้นตอนที่ 2: สร้างรายงานใหม่จากเทมเพลตที่เลือก

คำสั่ง:POST /insights/learnings/report_requests

ในตัวอย่างนี้ โปรดตรวจสอบให้แน่ใจว่าได้ส่งabc86b82-029a-4b74-9690-4ab607f3eafeเป็นtemplate_idในคำขอนี้

ตัวอย่างคำตอบ:

{
  "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": "รายงานทดสอบ",
      "description":"การทดสอบสำหรับ API สาธารณะ",
      "created_at": "2022-03-01T15:36:42.99789+01:00",
      "updated_at": "2022-03-03T09:48:46.06885+01:00"
    }
  }
}

โปรดทราบว่าค่าสำหรับurlยังไม่พร้อมใช้งาน ขึ้นอยู่กับปริมาณข้อมูลที่นำเข้าสู่รายงาน อาจใช้เวลาหลายนาทีในการสร้างรายงาน คุณจะต้องขอurlของรายงานของคุณในขั้นตอนต่อไป

ขั้นตอนที่ 3: รับ URL ของไฟล์รายงาน Excel

คำสั่ง:GET /insights/learnings/report_requests/{id}

โปรดใช้idสำหรับข้อมูลในคำตอบจากขั้นตอนที่ 2 ไม่ใช่idสำหรับเทมเพลต!

ตัวอย่างคำตอบ:

{
  "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": "รายงานทดสอบ",
      "description":"ทดสอบเพื่อวัตถุประสงค์ของ Public API",
      "created_at": "2022-03-01T15:36:42.99789+01:00",
      "updated_at": "2022-03-03T09:48:46.70689+01:00"
    }
  }
}

คุณอาจจำเป็นต้องรันคำขอนี้เป็นระยะ ๆ ทุก 30 วินาที จนกว่าจะได้รับคำตอบที่มีค่าสำหรับurl ระยะเวลาที่ใช้ขึ้นอยู่กับปริมาณข้อมูลที่ต้องการเพื่อสร้างรายงาน

ในตัวอย่างนี้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

การเข้าถึง URL นี้จะดาวน์โหลดรายงานของคุณในรูปแบบไฟล์ Excel.xlxs ขณะนี้ไม่สามารถดึงข้อมูลในรูปแบบไฟล์อื่น ๆ ได้ เช่น.csv

โปรดทราบ:ไฟล์นี้จะหมดอายุหลังจาก 10 นาที และต้องดาวน์โหลดก่อนหน้านั้น

ℹ️ หากแม่แบบรายงานถูกสร้างโดยผู้ดูแลกลุ่มซึ่งมีสิทธิ์เข้าถึงข้อมูลเฉพาะกลุ่มและผู้ใช้ที่เลือกไว้เท่านั้น ข้อจำกัดนี้จะยังคงมีผลเมื่อใช้ Motimate Public API