文字使用量の指標を取得

Deprecated
(非推奨)このエンドポイントは非推奨です。代わりに、`aggregation_interval`ではなくバケットサイズを`interval_seconds`(秒単位の整数)として公開する/v1/workspace/analytics/query/usage-by-product-over-timeを使用してください。現在のユーザー、または所属するワークスペース全体の使用状況メトリクスを返します。レスポンスには、指定した集計間隔(デフォルト:日)に基づく時間軸と、その軸に沿った各間隔の使用量が含まれます。使用量は、選択した内訳タイプ別に分類されます。たとえば、内訳タイプが"voice"の場合、時間軸上の各間隔における各音声の使用量が返されます。

ヘッダー

xi-api-keystringオプション

クエリパラメータ

start_unixinteger必須

使用期間の開始を示すUTC Unixタイムスタンプ(ミリ秒)。期間の初日を含めるには、その日の00:00:00をタイムスタンプに指定してください。

end_unixinteger必須

使用期間の終了を示すUTC Unixタイムスタンプ(ミリ秒)。期間の最終日を含めるには、その日の23:59:59をタイムスタンプに指定してください。

include_workspace_metricsbooleanオプションデフォルト値 false

ワークスペース全体の統計を含めるかどうか。

breakdown_typeenumオプション

情報の内訳方法です。include_workspace_metricsがFalseの場合、“user”は指定できません。

aggregation_intervalenumオプション

使用量データを時系列で集計する方法です。“hour”、“day”、“week”、“month”、または”cumulative”を指定できます。

許可された値:
aggregation_bucket_sizeinteger or nullオプション

集計バケットのサイズ(秒)。集計間隔を上書きします。

metricenumオプション

集計する指標。

レスポンス

成功レスポンス。

timelist of integers

各日のUnixタイムスタンプを含む時間軸です。

usagemap from strings to lists of doubles

時間軸に沿った各内訳タイプの使用量です。

エラー

422
Unprocessable Entity Error