ユーザー教材レポート

PATCHhttps://manabeat.com/{site_id}/mana_apis/user_material_report

ユーザー別に教材毎の受講状況を取得します。

next_page_tokenの仕様

per（デフォルト：1000）行より取得可能なデータ数が多い場合、レスポンスとしてnext_page_tokenが発行されます。
2ページ目以降のデータ取得はnext_page_tokenをパラメータにセットしてください。
全データの取得が完了した時点でnullが返却されます。

初回リクエストの絞り込み要素を引き継ぐため、next_page_tokenをセットしたリクエストではその他全てのパラメータが排除されます。

トークンの有効期限は30分です。一度使用したトークンの再使用は出来ません。

パスパラメータ

site_idstringrequired

サイトID

リクエストボディ

*2get_countbooleanrequired

true: 割り当て数のみ取得。false: 一覧情報を取得。

*2next_page_tokenstringrequired

2ページ目以降のデータ取得用に発行されたトークン。

perinteger

データの取得単位。デフォルト及び上限値：1,000

subject_ids[integer]

教科IDによる絞り込み。複数指定可能。

course_ids[integer]

科目IDによる絞り込み。複数指定可能。

course_typeenum

科目種別による絞り込み。["normal"(通常科目), "adaptive"(アダプティブ科目)]から選択。

material_ids[integer]

教材IDによる絞り込み。複数指定可能。

group_codes[string]

グループコードによる絞り込み。複数値でOR検索が可能。

properties[string]

属性名による絞り込み。複数値でOR検索が可能。

*3group_property_conditionsenum

グループ×属性。["AND", "OR"]から選択。

users[string]

ログインIDによる絞り込み。複数指定可能。

include_invalid_userboolean

出力結果に無効ユーザーを含めるかの可否。デフォルト：false

*4status[enum]

教材の受講ステータスによる絞り込み。["completed"(修了), "incomplete"(受講中), "not_attempted"(未受講)]から複数選択可能。

*4is_passed[boolean]

教材の合否による絞り込み。true：合格, false: 不合格。両方指定も可能。

optionalboolean

教材が属する科目が任意で割り当てられているかの可否。true: 任意割り当て, false: 必須割り当て

*1 取得ユーザー数10,000以下、取得教材数1,000以下、取得ユーザー×教材数1,000,000以下になるよう絞り込みが必須。
*2 get_count, next_page_tokenのいずれか一つ必須。
*3 グループと属性を両方指定する場合のみ、設定可能且つ必須パラメータとなる。
*4 status, is_passedを指定する場合のみ、教材数が10以下になるよう絞込みが必須。

レスポンスボディ

countinteger

取得データ数。get_count: true時に返却。

perinteger

リストの取得単位

next_page_tokenstring

次ページが存在する場合に発行されるトークン。

user_material_reportarray

以降の各パラメータを持つデータをリスト形式で返却する。

user_idinteger

ユーザーID

loginstring

ログインID

user_namestring

ユーザー名

subject_idinteger

教科ID

subject_name{ja: string, en: string, zh_CN: string, zh_TW: string}

教科名

course_idinteger

科目ID

course_name{ja: string, en: string, zh_CN: string, zh_TW: string}

科目名

material_idinteger

教材ID

material_name{ja: string, en: string, zh_CN: string, zh_TW: string}

教材名

statusstring

教材の受講ステータス

submission_statusstring

課題教材の提出状況

is_passedstring

課題の合否

scoreinteger/string

採点結果。課題教材且つ5段階評価の場合のみ"A"~"E"。

started_atstring

学習開始日(yyyy/mm/dd HH:MM:SS)

completed_atstring

学習修了日(yyyy/mm/dd HH:MM:SS)

last_learned_datestring

最終学習日時(yyyy/mm/dd HH:MM:SS)

total_timestring

総学習時間(HH:MM:SS)

first_scoreinteger/string

初回採点結果。課題教材且つ5段階評価の場合のみ"A"~"E"。

times_of_attendedinteger

受講回数

suspend_datastring

SCORM教材用サスペンドデータ

エラーレスポンス

400URLに誤りがあります。

リクエストURL、パスパラメータを確認してください。

400Content-Type情報が不正な値です。

リクエストヘッダー情報を確認してください。

400リクエスト内容を認識できません。

リクエストボディの読み込みに失敗しました。送信データを確認してください。

400使用出来ないパラメータが含まれています。parameter1…

メッセージに記載された項目のパラメータが使用できません。データ型等確認してください。

400必須パラメータが不足しています。parameter1…

一覧情報取得に必須のパラメータが不足しています。

400このトークンは無効です。next_page_token

セットされたトークンは期限切れ、または存在しません。

400ユーザーが10,000以下になるように絞り込みをしてください。

ユーザー数の絞り込み上限は10,000までです。

400教材が1,000以下になるように絞り込みをしてください。

教材数の絞り込み上限は1,000までです。

400ユーザー×教材が1,000,000以下になるように絞り込みをしてください。

ユーザー×教材の絞り込み上限は1,000,000までです。

400status, is_passedを指定する場合、教材が10以下になるように絞り込みをしてください。

status, is_passedのいずれかを含める場合、教材の絞り込み（上限10）が必須です。

403認証に失敗しました。

APIの認証に失敗しました。サイトID、APIキー、APIキー保有ユーザーの状況を確認してください。

403許可されていないIPからのリクエストです。

IPアドレス制限によってリクエストが制限されています。

413リクエストボディサイズが上限に達しています。

送信できるリクエストボディのサイズは100KBです。

429リクエスト制限中です。

1時間あたりのリクエストが5000回を超えています。時間を空けてからお試しください。

500予期せぬエラーが発生しました。

システム内部でエラーが発生しました。時間をおいて再度お試しください。

503システムメンテナンス中です。

現在システム全体のメンテナンス中です。終了までお待ちください。

503現在別のレポートAPIを処理中のため、APIを実行できません。

サイト内で実行可能なレポートAPIは同時に一つのみです。時間を空けてからお試しください。

503サイト内でレポートCSVエクスポートを処理中のため、APIを実行できません。

サイト内でレポートCSVエクスポート中はレポートAPIを実行できません。時間を空けてからお試しください。

リクエストボディ例（初回）

{
  "get_count": false,
  "subject_ids": [
    1234,
    5678
  ],
  "course_type": "normal",
  "material_ids": [
    1234
  ],
  "group_codes": [
    "group9999"
  ],
  "properties": [
    "property9999"
  ],
  "group_property_conditions": "OR",
  "include_invalid_user": true,
  "status": [
    "completed"
  ],
  "is_passed": [
    true,
    false
  ],
  "optional": false
}

リクエストボディ例（2ページ目以降）

{
  "next_page_token": "abcdefghi123456789"
}