Motimate：如何使用公共 API 生成報告

除了透過 Motimate xAPI，我們也支援從 Motimate Public API 擷取 Excel 檔案。 這些 Excel 報表是基於先前在「產生報表」中建立的報告範本。產生報表 功能中建立的報告範本。

在我們開始之前，這裡有一些有用的資訊：

三個相關的 Motimate Public API 功能為

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

在使用 Public API 產生報告之前，請確定已在「產生報告」中產生報告範本(請參閱此處的指南)，而且您知道要從哪些範本產生報告。 只要準備就緒，產生報告的過程將需要三個步驟：

步驟 1：取得報告範本清單：

指令：GET /insights/learnings/report_templates

回應範例：

{
  「資料」：[
    {
      **"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"
      }
    }
  ]
}

記下您在下一步中需要使用的範本ID，本例中為：abc86b82-029a-4b74-9690-4ab607f3eafe

步驟 2：根據所選範本產生新報告

指令：POST /insights/learnings/report_requests

在本範例中，請確定在此要求中提交abc86b82-029a-4b74-9690-4ab607f3eafe作為template_id。

回應範例：

{
  「資料」：{
    **"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"
    }
  }
}

請注意，目前還沒有url的值。 視報告的資料多寡而定，產生一份報告可能需要數分鐘的時間。 下一步您將要求報告的網址。

步驟 3：取得 Excel 報告檔案的 URL

指令：GET /insights/learnings/report_requests/{id}

確保在步驟 2 的回應中使用資料的id，而不是範本的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>"**,
    「模板」：{
      "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"
    }
  }
}

您可能需要每 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 將會以.xlxsExcel 檔案下載您的報告。 目前無法以任何其他檔案格式 (例如.csv) 擷取資料。

請注意：檔案會在 10 分鐘後過期，必須在此之前下載。

ℹ️ 如果報告範本是由群組管理員建立，而該群組管理員只有有限的權限存取所選群組和使用者的資料，則在使用 Motimate Public API 時，此限制仍然有效。