シナリオ対話ログ件数取得API

アクセス権限
特権 サーバ管理 テナント管理 シナリオ設計 AIML編集者

シナリオ対話ログ件数の取得を行うAPIです。

エンドポイント

URL

https://sunaba.xaiml.docomo-dialog.com/NLPManagementAPI/projects/{projectId}/logs/count
https://sunaba.xaiml.docomo-dialog.com/NLPManagementAPI/projects/{projectId}/logs/count?botId={botId}&start={start}&end={end}

リクエスト

Method POST
Header Authorization ログインAPIで払い出したアクセストークンを指定します。
  Content-Type application/json;charset=UTF-8
Body JSON形式。(詳細はリクエストパラメータを参照)

レスポンス

ステータスコード

成功

  • 200(OK)

エラー

  • 400(Bad Request)
  • 401(Unauthorized)
  • 403(Forbidden)
  • 404(Not Found)
  • 429(Too many requests)
Body JSON形式。(詳細はレスポンスパラメータを参照)

URLパラメータ

パラメータ名 説明
projectId シナリオ対話ログ件数を取得する対象のプロジェクトIDを設定します。
botId シナリオ対話ログ件数を取得する対象のボットIDを設定します。
省略した場合は全ボットが対象となります。
start 検索期間の開始日時を設定します。
startを設定してendを設定しない場合はstart以降の期間を対象に取得します。

フォーマット:YYYY-MM-DD hh:mm:ss
ミリ秒部分は自動で000が設定されます。

end 検索期間の終了日時を設定します。
endを設定してstartを設定しない場合はend以前の期間を対象に取得します。
startendともに省略した場合は全期間が対象となります。

フォーマット:YYYY-MM-DD hh:mm:ss
ミリ秒部分は自動で999が設定されます。

リクエストパラメータ

システム対話ログ取得APIのリクエストパラメータと同様です。

レスポンスパラメータ

キー
必須 説明
count integer システム対話ログ件数が設定されます。

レスポンス例(正常)

レスポンス例(エラー)

HTTPステータス/原因 レスポンス内容
400(Bad Request)
  パラメータ不正
401(Unauthorized)
  トークン不正 なし
  パスワードが期限切れもしくは旧式や初期パスワード なし
403(Forbidden)
  アクセス権不正 なし
429(Too many requests)
  ロックアウト なし