Skip to main content
ベース URL：https://xxxx.comdesk.com/api/v1
レポート API は open_api_advanced ライセンス（ない場合は 403 license_required）と、reports:read スコープを持つキーが必要です。
レポートは日次の集計データから作成されるため、最小単位は 1 日です。

共通クエリパラメータ

string
required
開始日、YYYY-MM-DD。最大 180 日前まで指定できます。
string
required
終了日、YYYY-MM-DD。from 以降の日付。範囲は 31 日を超えられません。いずれかのルールに違反すると 422 を返します。
integer
プロジェクトで絞り込み。

指標フィールド

内訳レポートとユーザー別レポートは、各行に次の指標を返します：

サマリーレポート

GET /reports/summary 期間内のテナント単位の合計値。共通パラメータのみを受け付けます。

通話内訳レポート

GET /reports/calls スタッフ・プロジェクト・日・週でグループ化した通話指標。BI 向けの抽出に適しています。
integer
スタッフで絞り込み。
string
default:"staff"
staff（各行に staff_id、staff_name）、project（project_id、project_name）、day または week（period_start、period_end。週は月曜始まり）。
integer
default:"1"
integer
default:"50"
最大 200。
staff / project の行は total_out_calls の降順、day / week の行は時系列順に並びます。

ユーザーレポート

GET /reports/users スタッフごとに 1 行。staff_id、staff_name（スタッフが削除済みの場合は null）、および指標フィールド（上記「指標フィールド」を参照）を含みます。
string
default:"total_out_calls"
total_out_calls、total_in_calls、total_out_connected、connection_rate、または total_duration_seconds。
string
default:"desc"
asc または desc。
integer
default:"1"
integer
default:"50"
最大 100。
31 日を超える期間のデータは、連続した範囲で複数回リクエストし、結果を自社側で結合してください。