Benefits of API Dashboard

1. Centralized Monitoring: The dashboard provides a centralized view of API usage, allowing easy and continuous monitoring of the usage of API calls.

1. In-depth insights of API calls: The dashboard gives insights about the frequently used APIs, and the applications that are utilizing the most number of API calls.

1. Detailed data visualization: API usage data is presented in a visually appealing and organized manner using charts, graphs, and other visual elements. This enables users to easily interpret and analyze the data
   

Accessing the API Dashboard

Admins can access the API Dashboard by following the below steps:

1. Click the Setup icon () in the top-right corner.
2. Under the Developer Space menu, click the API.
3. Under the API sub-menu, click the API Dashboard. 
   

For example, if you recorded the following number of API calls over four days:

Day 1: 500, Day 2: 600, Day 3: 700, and Day 4: 550 

The daily average is (500+600+700+550)/ 4

The API calls made via in-house integrations listed under Setup-->Marketplace-->Zoho do not count towards consumed APIs except Zoho Flow.

API calls by Zoho Services

API calls by Applications

To utilize ZohoDesk's APIs, users need an OAuth token or Zoho Connection. To generate an OAuth token, users must register their application in the Zoho API Console.

API calls by Zoho Desk Custom Functions

1. The API calls triggered by the custom function include Automation, Schedule, and Marketplace.
2. API calls originated from the custom functions under Blueprint, Workflows, and Macros are displayed under Automation.
3. Clicking on a Custom Function will redirect admins to the Custom Function Detail View page.
   

API calls by Zoho Desk Entities

Most used APIs 

The Admin can view the most frequently used APIs within the chosen timeframe.

Both the API Name and the Path will redirect users to the corresponding API in the Zoho Desk API documentation.

API calls by Access Points

API calls by users

This section displays the number of API requests made by individual users over a selected period.

The API call count(API calls) corresponds to the number of calls made using the credentials(User Name) to generate the OAuth token.

API usage trend

It displays how often an API is being accessed and utilized over a certain period of time. This type of metric can provide valuable insights into identifying patterns in an API usage. 

Date and total calls: Displays the date and the total count of API calls made within a specified range of days.

Hourly breakdown: Provides an hour-by-hour breakdown of API calls made within a single day.

API Usage Matrix

Accessing the API Usage Matrix

Admins can access the API Usage Matrix by following the below steps:

1. Click the Setup icon () in the top-right corner.
2. Under the Developer Space menu, click the API.
3. Under the API sub-menu, click the API Usage Matrix.
   

      4. Under the API USAGE MATRIX section, click on " ". This will list the available components in the drop-down list. 

You can perform the following actions:

1. Rearrange the order of components in the drop-down list.
2. Choose up-to maximum of four components to view at once.
   

1. The API Usage Matrix is available in all paid editions.  
2. Users with Helpdesk Automation permission in their profile can access the API Usage Matrix.   
3. The Support Administrator will receive notifications when the API limits reach 80% and 90% of the permissible limit.
   

1. Today (morning 00:00 to the current time on a particular day)
2. Yesterday
3. Last 7 days
4. Last 30 days
5. Customize (90 days. The range between the Start Date and End Date cannot exceed 90 days. For instance, if the Start Date is December 20th, 2023, the End Date should not exceed September 21st, 2023. Admins can view data for a specific day by specifying the same date for both the Start Date and End Date.)
   

1. There is a 15-minute delay in displaying the data in all components.
2. The admin is limited to retrieving data for the last 90 days.

To ensure service availability for all customers, Zoho Desk may restrict the number of API calls for a portal if any unusual behavior is detected from a particular account. Following the limitation of API calls, Zoho Desk Support will email the Support Administrator of the account to notify them of the limitation.

Data display time

The data display time is determined by the portal's time zone (the time zone of the server hosting the portal), regardless of the user's location or time zone. This is to ensure consistency and accuracy in the data presentation. 

For example, assume that Zoho Desk is hosted on a server in Los Angeles, and a user in Mumbai accesses the API dashboard. The data displayed will be in the time zone of the Data Center where the server is located. As the Data Center (dedicated servers for hosting Zoho applications) is in Los Angeles, the API dashboard will show data based on local time in Los Angeles. 

The API dashboard's footer will contain GMT timezone information.