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

除了通过 Motimate xAPI我们还支持从 Motimate 公共 API 提取 Excel 文件。 这些 Excel 报告基于之前在生成报告 功能创建的报告模板。

在我们开始之前，这里有一些有用的信息：

三个相关的 Motimate 公共 API 功能是

• 获取 /insights/learnings/report_templates
   
• 发帖 /insights/learnings/report_requests
   
• GET /insights/learnings/report_requests/{id}

在使用公共 API 生成报告之前，请确保已在 "生成报告 "中生成了报告模板（请参阅此处的指南），并且知道将从哪个模板生成报告。 如果准备就绪，生成报告的过程将需要三个步骤：

步骤 1：获取报告模板列表：

命令：GET /insights/learnings/report_templates

回复示例：

{
  "数据"：[
    {
      **"id"："abc86b82-029a-4b74-9690-4ab607f3eafe "**,
      "name"："报告测试"，
      "描述"："公共 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"
      }
    }
  ]
}

记下下一步需要使用的模板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"："报告测试"，
      "description"："公共 API 目的测试"，
      "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"："报告测试"，
      "description"："公共 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 将以.xlxsExcel 文件格式下载报告。 目前还无法提取其他文件格式的数据，例如.csv。

请注意：文件将在10 分钟后过期，必须在此之前下载。

ℹ️ 如果报告模板是由组管理员创建的，而组管理员只能有限地访问选定组和用户的数据，则在使用 Motimate 公共 API 时，此限制仍然有效。