教材レポート

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

教材別の統計レポートを取得します。

パスパラメータ

site_idstringrequired

サイトID

リクエストボディ

material_idintegerrequired

取得する科目のID指定

group_codes[string]

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

properties[string]

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

*group_property_conditionsenum

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

users[string]

ログインIDによる絞り込み。

include_invalid_userboolean

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

optionalboolean

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

* グループと属性を両方指定する場合のみ、設定可能且つ必須パラメータとなる。

レスポンスボディ

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}

教材名

assigned_countinteger

割当受講者数

completedinteger

修了受講者数

passedinteger

合格受講者数

failedinteger

不合格受講者数

incompleteinteger

受講中受講者数

not_attemptedinteger

未受講者数

avg_scorefloat

平均点

max_scorefloat

最高点

min_scorefloat

最低点

エラーレスポンス

400URLに誤りがあります。

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

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

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

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

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

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

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

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

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

403認証に失敗しました。

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

リクエストボディ例

{
  "material_id": "999999,",
  "group_codes": [
    "group9999"
  ],
  "properties": [
    "property9999"
  ],
  "group_property_conditions": "OR",
  "include_invalid_user": true,
  "optional": false
}