Motimate：公開APIを使用してレポートを生成する方法

によるコース修了データの共有に加え Motimate xAPIまた、Motimate Public API からの Excel ファイルの抽出もサポートしています。 これらのエクセル・レポートは、以前にレポートの作成 機能で作成したレポートテンプレートに基づいています。

始める前に知っておくと便利な情報がある：

関連する Motimate Public API 関数は次の 3 つです：

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

Public API を使用してレポートを生成する前に、レポート・テンプレートがレポート生成で既に生成されていることを確認し（こちらのガイドを参照）、どのテンプレートからレポートを生成するのかを知っておいてください。 この準備が整えば、レポートの作成には3つのステップが必要になる：

ステップ1：レポートテンプレートのリストを取得する：

コマンドGET /insights/learnings/report_templates

回答例

{
  "data"：[
    {
      **"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

この例では、template_idとして abc86b82-029a-4b74-9690-4ab607f3eafeをリクエストしてください。

回答例

{
  "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"："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の値はまだ利用できませんのでご注意ください。 レポートのデータ量にもよりますが、レポート作成に数分かかる場合もあります。 次のステップでは、レポートのURLをリクエストします。

ステップ3：エクセル・レポート・ファイルの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>"**,
    "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.70689+01:00"
    }
  }
}

urlの値を含む応答を得るまで、30秒ごとにこのリクエストを繰り返し実行する必要があるかもしれない。 どのくらいの時間がかかるかは、レポートを作成するのに必要なデータの量による。

この例では、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 を使用してもこの制限は有効です。