APIダッシュボードの利用
APIダッシュボード
Zoho Deskには、他のサービスと連携するためのAPI（Application Programming Interface）の機能が用意されています。APIの利用状況については、ダッシュボードで確認できます。具体的には、対象期間におけるAPIの実行回数、処理内容、アクセス元などの詳細を、表やグラフで見やすく確認することが可能です。管理者は、ダッシュボードを通じてAPIの利用状況が適切かどうかを確認し、必要に応じて利用方法を最適化するなどの対応をとることができます。
APIダッシュボードのメリット
- 必要な情報を一か所で確認できる：ダッシュボードには、APIの利用に関する情報がまとめて表示されます。全体的な状況や傾向を簡単に把握できます。
- 実行状況について深く分析できる：よく実行されているAPIの処理内容やアクセス元のアプリケーションなど、さまざまな角度から実行状況について調査、分析できます。
- データを見やすく表示できる：
実行状況に関するデータは、グラフや表などの形式で見やすく表示されます。数値だけでは分かりづらい内容を、直感的に理解できます。
APIダッシュボードへのアクセス
必要な権限を持つユーザーが、APIダッシュボードにアクセスできます。手順は以下のとおりです。
- 画面右上に表示されている
（設定）アイコンをクリックします。
- ［開発者向け情報］の欄で、［API］をクリックします。
- 画面左側のメニューから、［APIダッシュボード］をクリックします。
- APIダッシュボードの機能は、すべての有料プランで利用できます。
- ただし、スタンダードプランでは、カスタム関数を通じたAPIの実行に関する情報は表示されません。エンタープライズプランとプロフェッショナルプランで確認できます。
- APIダッシュボードにアクセスできるのは、業務の自動化の権限を持つユーザーです。
- APIの実行回数の上限のうち、80%を超えてAPIが実行されたときには、システム管理者に対して通知が送信されます。同様に、90%を超えたときにも送信されます。
APIダッシュボードは、Zoho Deskのモバイルアプリ「Radar」でも参照できます。
ダッシュボードに表示される内容
ダッシュボードには、以下の内容がそれぞれ表示されます。
内容 | 指標 | 表示形式 |
| ドーナツグラフ | |
| ドーナツグラフ、棒グラフ、円グラフ、表 | |
| ドーナツグラフ、棒グラフ、円グラフ、表 | |
| ドーナツグラフ、棒グラフ、円グラフ、表 | |
| ドーナツグラフ、棒グラフ、円グラフ、表 | |
| ドーナツグラフ、棒グラフ、円グラフ、表 | |
| ドーナツグラフ、棒グラフ、円グラフ、表 | |
| ドーナツグラフ、棒グラフ、円グラフ、表 | |
| 線グラフ、棒グラフ、表 |
- なお、ダッシュボードを表示中に最新情報を反映するには、ダッシュボードを手動で再読み込みする必要があります。その際、ダッシュボード全体を再読み込みすることも、個々の内容ごとに再読み込みすることもできます。
- 表形式での表示の場合、表示されるデータは最新の1,000件です。ドーナツグラフ、線グラフ、棒グラフ、円グラフの場合は、上位10件の区分（系列）です。
- グラフ形式での表示において、［すべて表示する］メニューをクリックすると、データの一覧が表形式で表示されます。
APIの利用状況
一定期間内におけるAPIの利用状況が表示されます。管理者は、こちらに表示される指標を定期的に確認することで、APIの利用状況が適切な範囲に収まっているかどうかを確認し、上限を超えそうな場合にはあらかじめ代替案を考えておくなどの対応をとることができます。
指標 | 説明 |
APIの実行数 | 対象期間内におけるAPIの実行回数の合計です。 |
APIの実行可能数 | 対象期間内におけるAPIの実行回数の上限から、すでに実行された回数を引いた数です。残りあと何回APIを実行できるかを表します。 メモ：1日あたりの実行回数が上限を下回っていた場合でも、その残りの実行可能数を翌日に繰り越すことはできません（1日あたりの上限は常に一定です）。 |
| 1日あたりの上限 | 1日あたりのAPI実行回数の上限です。 |
日単位の平均 | 対象期間におけるAPI実行回数の平均を日単位で算出したものです。 |
たとえば、4日間におけるAPIの実行回数が以下のとおりだったとします。
1日目：500、2日目：600、3日目：700、4日目：550
この場合、日単位の平均は、（500＋600＋700＋550）÷4＝587.5となります。
なお、他のZohoサービスとの連携機能（［設定］→［マーケットプレイス］→［Zoho］のメニューから利用できる連携機能や拡張機能）を通じて実行されたAPIについては、実行回数としてカウントされません（上限の対象外として扱われます）。ただし、Zoho Flowを通じた処理については例外です。
Zohoサービス別のAPI実行数
Zoho Deskは、他のさまざまなZohoサービスと連携できます（例：Zoho CRM、Zoho Books）。こちらの表には、Zohoサービス別にAPIの実行回数が表示されます。たとえば、Zoho CRMからAPIを通じてZoho Deskのデータにアクセスした場合、アクセスするたびに実行回数が加算されます。こうした情報を通じて、どのZohoサービスとの連携機能においてAPIがよく実行されているかを確認できます。
アプリケーション別のAPI実行数
Zoho Deskは、他のZohoサービスだけでなく、さまざまな外部サービスとも連携可能です。こちらの表には、そうした連携機能を通じて実行されたAPIに関する情報が表示されます。こうした情報を通じて、どの外部サービスとの連携機能においてAPIがよく実行されているかを確認できます。
Zoho DeskのAPIの利用にあたっては、OAuthトークンと呼ばれる認証用のトークンを発行するか、連携用の設定を行う必要があります。OAuthトークンを発行するには、Zoho APIの利用者向けページ（Zoho API Console）において、トークンを利用するアプリケーションの情報を登録する必要があります。
表内のアプリケーション（APPLICATIONS）の列には、Zoho APIの利用者向けページ（Zoho API Console）で登録した名前が表示されます。
Zoho Deskのカスタム関数別のAPI実行数
カスタム関数は、Zoho Deskにおける各種処理を自動化するための機能です。関数を記述することで、要件に合わせて任意の処理を実行でき、APIを実行することも可能です。なお、カスタム関数を実行するためには、何らかの自動化処理や拡張機能と関連付ける必要があります。関連付けた自動化処理や拡張機能を通じてAPIを実行できます。表には、カスタム関数を通じて実行されたAPIの回数が一覧で表示されます。
- カスタム関数の名前の他、カスタム関数が関連付けられている処理の種類もあわせて表示されます（例：自動化、スケジュール処理、マーケットプレイス）。
- ワークフロー、ブループリント、マクロを通じて実行されたカスタム関数の情報は、［自動化］の種類に分類されて表示されます。
- 必要に応じて、カスタム関数の詳細ページを確認することも可能です。
Zoho Deskのデータの種類別のAPI実行数
APIは、さまざまな種類のデータに対して実行することができます（例：問い合わせ、取引先）。こちらのグラフには、APIの実行回数がデータの種類別に表示されます。
なお、データの種類名として表示される名前は、Zoho DeskのAPIを実行するうえでの参照用の名前です（画面上での表示名とは必ずしも一致しません）。詳細については、Zoho DeskのAPIのヘルプドキュメントをご参照ください。
実行数が多いAPI
こちらの表には、実行回数が多いAPIが、実行数順に表示されます。
また、API名とパス（API実行用URLの末尾の部分）の情報が、あわせて表示されます。API名とパスの詳細については、Zoho DeskのAPIのヘルプドキュメントをご参照ください。
アクセス元別のAPI実行数
こちらのグラフには、APIの実行回数がアクセス元のIPアドレス別に表示されます。対象期間において、どのIPアドレスからのAPIの実行が多かったかを確認できます。
ユーザー別のAPI実行数
こちらの表には、APIの実行回数がユーザー別に表示されます。
なお、APIの実行者として表示されるユーザーは、該当のAPIの実行に使用された認証トークン（OAuthトークン）をもとに識別されます（トークンの発行者が実行者として扱われます）。
APIの利用傾向
このグラフには、対象期間におけるAPIの利用状況に関する傾向が表示されます。具体的には、以下の情報を確認できます。
日別の実行回数：APIの実行回数について日別の推移を確認できます。
時間帯別の実行状況：1日の中の時間帯別の実行状況を確認できます。
API利用状況レポート
Zoho Deskには、APIダッシュボードとは別に、API利用状況レポートが用意されています。API利用状況レポートでは、表示項目を自分で切り替えながら利用状況を確認して分析することが可能です。
API利用状況レポートにアクセスするには
必要な権限を持つユーザーが、API利用状況レポートにアクセスできます。手順は以下のとおりです。
- 画面右上に表示されている
- ［開発者向け情報］の欄で、［API］をクリックします。
- 画面左側のメニュー一覧から、［API利用状況レポート］をクリックします。
4.表において、
アイコンをクリックすると、表示項目をカスタマイズできます。
以下の操作が可能です。
- 表示項目の順番を並べ替える
- 表示項目を選択する（最大4件）
- API利用状況レポートの機能は、すべての有料プランで利用できます。
- API利用状況レポートにアクセスできるのは、業務の自動化の権限を持つユーザーです。
- APIの実行回数の上限のうち、80%を超えてAPIが実行されたときには、システム管理者に対して通知が送信されます。同様に、90%を超えたときにも送信されます。
対象期間の選択
フィルターを利用することで、ダッシュボード内の表やグラフに表示するデータの対象期間を選択できます。
- 今日（0時から現在時刻まで）
- 昨日
- 過去7日間
- 過去30日間
- 任意の期間：最大90日間。開始日と終了日を指定できますが、その期間は90日を超えることはできません。たとえば、開始日を2024年9月1日とした場合、終了日を2024年11月29日より後にすることはできません。なお、開始日と終了日に同じ日付を指定することで、該当の日についてのみのデータを確認することもできます。
- なお、APIの実行データが表やグラフに反映されるまでに、15分程度かかることがあります。
- 対象期間として選択できるのは、最大90日間です。
利用しているZoho DeskのポータルにおいてAPIの実行回数が急激に増えているなど、通常とは異なる状況が検知された場合、APIの実行が制限される場合があります。その場合、Zoho Deskのサポート担当者から、該当のポータルのシステム管理者に対して、メールで通知が送信されます。
データのタイムゾーン
表示されるデータの日時については、ポータルが登録されているサーバーのタイムゾーンが適用されます。これは、データの表示内容の一貫性や整合性を保つためです。
たとえば、利用しているZoho Deskのポータルがロサンゼルスのサーバーに登録されているとします。また、該当のポータルの管理者ユーザーが、APIダッシュボードに東京からアクセスしたとします。この時、表示されるデータの日時のタイムゾーンには、東京のタイムゾーンではなく、ロサンゼルスのタイムゾーンが適用されます。
適用されているタイムゾーンの情報は、APIダッシュボードのページ下部に表示されます。