- ワークスペース全体およびユーザー個別のクレジット使用状況を追跡する。
- ワークスペースのクレジットプールとメンバーごとのクレジット上限を監視する。
- ユーザーアクティビティを監視し、非アクティブなアカウントを特定する。
- アプリのセキュリティ設定を監査する。
- ビュー、アクティブユーザー、使用傾向によるエンゲージメントを分析する。
ワークスペース
ワークスペース は、チームがアプリで共同作業を行う共有環境です。Monitoring API は、ワークスペースの owner および admin に、特定のワークスペース内のユーザーとアプリの集計データを提供します。Workspace ID
ほとんどのエンドポイントは URL パスにworkspace_id を必要とし、そのワークスペースで admin または owner ロールを持っている必要があります。
workspace_id を取得するには、ワークスペース管理ページに移動します。
- アカウントの右上にあるプロフィールアイコンをクリックします。
- 該当するワークスペースにカーソルを合わせ、Manage をクリックします。
- ワークスペース管理ページの URL の末尾がワークスペース ID です。
クレジットプールとメンバー上限
ワークスペースは、クレジットリセット期間ごとに単一のクレジットプールを共有します。プールはメッセージクレジットとインテグレーションクレジットを別々に追跡し、それぞれの上限、使用量、残量を報告します。リセット期間は請求ページに表示されているものと一致します。月次でリセットされる年次サブスクリプションの場合、月単位のウィンドウになります。Get analytics のレスポンスは、このデータを credit_pool オブジェクトで返します。ティア、日次メッセージ上限、ボーナスクレジット、ギフトカード残高、上限超過フラグが含まれます。
ワークスペースは、メンバーが共有プールから引き出せるメッセージクレジット数についてメンバーごとの上限を設定することもできます。メンバーの上限は、個別の上書き設定またはワークスペースのデフォルトのいずれかから決まります。analytics レスポンスの member_allocations オブジェクトはワークスペース全体のこれらの上限をまとめ、Get user の各ユーザー上の member_allocation オブジェクトは個別メンバーの上限と使用量を報告します。
メンバーごとのクレジット上限はワークスペースのティアに依存します。ティアがサポートしていない場合、メンバーは個別の上限なしにプールから引き出し、メンバーごとのフィールドは
null を返します。ワークフロー例
Monitoring API の一般的な使用例をいくつか紹介します。月次使用状況を比較する
1
今月の analytics を取得する
今月の日付範囲で
Get analytics を呼び出して、現在のクレジット消費とユーザーアクティビティを取得します。2
先月の analytics を取得する
先月の日付範囲で再度
Get analytics を呼び出し、トレンドを比較します。ユーザーアクティビティを分析する
1
ユーザーを一覧表示する
List users を呼び出して、現在の請求期間のサマリー消費データを持つすべてのユーザーを取得します。2
ユーザーを取得する
Get user を呼び出して、特定のユーザーのカスタム日付範囲での消費データを取得します。クレジット上限を超えたメンバーを見つける
1
上限を超えたユーザーを一覧表示する
over_member_limit=true を指定して List users を呼び出すと、現在のクレジットリセット期間でメンバーごとのクレジット上限を超えたメンバーのみが返されます。2
メンバーの割り当て詳細を取得する
特定のメンバーについて
Get user を呼び出し、上限、上限のソース、残りのクレジットを含む member_allocation を確認します。アプリを監査する
1
ユーザーを一覧表示する
List users を呼び出して、ワークスペース内のユーザーを見つけます。2
ユーザーのアプリを一覧表示する
List user apps を呼び出して、特定のユーザーのアプリ ID を取得します。3
アプリの analytics を取得する
Get app analytics を呼び出して、アプリの詳細なメトリクスとガバナンスフラグを取得します。このページは AI を使用して翻訳されました。最も正確で最新の情報については、英語版 を参照してください。