この記事では、IntercomのREST APIおよびCSVエクスポートを使用して計算できるレポート指標について説明します。生のAPIデータからカスタムレポートを作成したり、ワークスペースのダッシュボードとCSVエクスポート間の不一致をトラブルシューティングしたり、Intercomの異なるレポートシステム間で指標がどのように対応しているかを理解するために使用してください。この記事は、プログラム的または一括エクスポートでIntercomの会話データにアクセスする開発者およびデータアナリストを対象としています。
​
すべての指標がREST APIで計算できるわけではありません。APIエンドポイントに含まれていないデータもあります。ご契約のIntercomプランでREST APIアクセスおよびCSVエクスポートが利用可能かご確認ください。

以下の表は、Intercomの会話エンドポイントで利用可能なREST API指標を示しています。これらを使用してカスタムレポートを作成したり、会話データをプログラム的にクエリしたりできます。

以下の期間はすべて秒単位で表され、営業時間を除きます。これらは会話オブジェクトのREST APIフィールドです。

以下のセクションでは、IntercomのElasticsearchレポートパイプラインで利用可能な同等の指標を示します。ElasticsearchはIntercomの組み込みレポートチャートを支えるデータストアです。指標が「[API指標]と同じ」と定義されている場合、計算は同一でフィールド名のみ異なります。

ElasticsearchはIntercomの組み込みレポートチャートを支えるデータストアです。Intercomは2つのElasticsearchパイプラインを維持しています。現在のレポート機能で使用される新しいパイプラインと、古いチャートで使用されるレガシーパイプラインです。以下のセクションでは、上記のREST API指標に対応するElasticsearchのフィールド名を示します。フィールドが「[APIフィールド]と同じ」と定義されている場合、基礎計算は同一でフィールド名のみ異なります。

これらはElasticsearch新パイプラインのタイムスタンプフィールドです。REST APIのタイムスタンプに直接対応し、ワークスペースの現在のレポートチャートを支えています。

これらはElasticsearch新パイプラインの期間フィールドで、秒単位で表されます。REST APIの期間指標に対応しています。

Intercomレポートの「新規インバウンド会話」チャートは、UserMessageメッセージ（顧客が開始した会話）にリンクされた会話のデータを表示します。選択された期間は会話のcreated_atタイムスタンプに適用され、メッセージスレッドのcreated_atには適用されません。

CSVエクスポートは、選択された期間内のメッセージスレッドにリンクされたデータをダウンロードします。すべてのメッセージタイプの会話を含むため、ワークスペースの個別のレポートチャートよりも広範囲です。

例えば、Intercomレポートの「新規インバウンド会話」チャートはUserMessageメッセージタイプにリンクされた会話のみを表示しますが、CSVエクスポートはすべてのメッセージタイプにリンクされた会話を含みます。これがCSVエクスポートの合計が個別チャートの数値と一致しない理由です。

以下のシナリオは、異なる会話タイムラインでレポート指標がどのように計算されるかを示しています。各シナリオは、イベントが会話内で発生するタイミングに応じてタイムスタンプと期間がどのように適用されるかを示します。

シナリオ1：単一の開閉サイクルを持つ単純な会話で、first_contact_reply_at、first_admin_reply_at、および関連するタイムスタンプがどのように計算されるかを示すタイムライン例。

シナリオ2：会話がクローズされた後に再オープンされた場合に、last_close_at、count_reopens、およびtime_to_last_closeがどのように計算されるかを示すタイムライン例。

シナリオ3：会話がクローズされる前に複数の割り当てと管理者の返信がある場合に、time_to_assignmentおよびlast_assignment_admin_reply_atがどのように計算されるかを示すタイムライン例。