Working with API Dashboard
API Dashboard
The API dashboard is a visual interface that provides users a comprehensive view of API (Application Programming Interface) usage. This tool helps users track and analyze the API usage, providing insights about the services utilizing the APIs over a specific period. It enables admins and decision makers to comprehend the effective utilization of APIs.
Benefits of API Dashboard
- Centralized Monitoring: The dashboard provides a centralized view of API usage, allowing easy and continuous monitoring of the usage of API calls.
- 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.
- 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:
- Click the Setup icon (
) in the top-right corner.
- Under the Developer Space menu, click the API.
- Under the API sub-menu, click the API Dashboard.
- The API dashboard is available in all paid editions.
- All components, except for the Custom Function component, are displayed in the Standard Edition. The Custom Function component is available in the Enterprise and Professional editions.
- Users with Helpdesk Automation permission in their profile can access the API dashboard.
- The Support Administrator will receive notification emails when the API limits reach 80% and 90% of the permissible limit. The threshold and alert recipients can be customized using the API Usage Alerts feature.
The API dashboard is available in the Radar for Zoho Desk app.
Understanding the Dashboard components
The dashboard is categorized into the following components to provide a detailed, organized break-up of API usage:
Components | Metrics | Supported Representation |
| Donut graph | |
| Donut, table, bar, and pie chart | |
| Donut, table, bar, and pie chart | |
| Donut, table, bar, and pie chart | |
| Donut, table, bar, and pie chart | |
| Donut, table, bar, and pie chart | |
| Donut, table, bar, and pie chart | |
| Donut, table, bar, and pie chart | |
| Line, table, and bar chart |
- Dashboard needs to be refreshed manually to display the most recent changes. Viewers can refresh the entire dashboard or the individual component to see the most recent data.
- The dashboard displays the top 1000 records in the table view and the top 10 records represented in other formats such as Donut, Line, Bar, and Pie charts.
- The View All option will transform any chart display into a table format.
API usage
This section refers to the API usage, which helps admins to monitor and analyze API usage within a specific timeframe. Consistent tracking of these metrics enables admins to keep track of acceptable limits to prevent service interruptions.
Metrics | Description |
API calls made | Total number of API requests that have been executed. |
Unused API calls | Total number of API calls that were not utilized until the chosen day or date range. Note: Balance API calls from the previous day cannot be carried forward. |
| Daily Limit | The maximum number of API calls allowed in a day. |
Daily Average | Summation of API calls made each day to the selected number of days. |
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
Zoho Desk account can be integrated with several other Zoho services to streamline the business processes. This component displays the number of times each Zoho service (eg., Zoho CRM, Zoho Books, etc.) has accessed the API. For example, if Zoho CRM pulls data using an API, each instance of this action counts as an API call. It helps to monitor and track the usage of the API by different services.
API calls by Applications
This component refers to the number of API calls that were used by third-party applications that are integrated with Zoho Desk. This helps to identify which applications are consuming the most API resources.
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.
The name displayed under the Applications denotes the application's name created in the Zoho API Console.
API calls by Zoho Desk Custom Functions
Custom functions are pieces of code that are written specifically for a particular application to perform specific tasks. Custom functions are executed automatically when certain events occur or applications meet specific needs. These custom functions make API calls to retrieve the required information. This section refers to the number of times the API is being accessed by the custom functions within an application.
- The API calls triggered by the custom function include Automation, Schedule, and Marketplace.
- API calls originated from the custom functions under Blueprint, Workflows, and Macros are displayed under Automation.
- Clicking on a Custom Function will redirect admins to the Custom Function Detail View page.
API calls by Zoho Desk Entities
APIs are categorized under different entities such as Tickets, Contacts, Accounts, etc., based on the configuration made in the Zoho Desk account. This component displays the total number of API requests made by each entity for a selected period.
The Entity Name corresponds to the name mentioned in the Zoho Desk API documentation.
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
This section refers to a metric that tracks API usage by different access points. It measures how many API requests have been made through a specific access point over a certain period of time.
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
The API Usage Matrix presents a tabular overview of the API calls that are made within the Desk account. It offers a comprehensive, component-wise view of API utilization, that gives insights into the usage patterns.
Accessing the API Usage Matrix
Admins can access the API Usage Matrix by following the below steps:
- Click the Setup icon (
- Under the Developer Space menu, click the API.
- 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:
- Rearrange the order of components in the drop-down list.
- Choose up-to maximum of four components to view at once.
- The API Usage Matrix is available in all paid editions.
- Users with Helpdesk Automation permission in their profile can access the API Usage Matrix.
- The Support Administrator will receive notifications when the API limits reach 80% and 90% of the permissible limit.
Data filtration for representation
You can view the data based on the below filters:
- Today (morning 00:00 to the current time on a particular day)
- Yesterday
- Last 7 days
- Last 30 days
- 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.)
- There is a 15-minute delay in displaying the data in all components.
- 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.
Access your files securely from anywhere
Zoho CRM Training Programs
Learn how to use the best tools for sales force automation and better customer engagement from Zoho's implementation specialists.
Zoho DataPrep Personalized Demo
If you'd like a personalized walk-through of our data preparation tool, please request a demo and we'll be happy to show you how to get the best out of Zoho DataPrep.
- Zoho Workerly Home
- Forums
- Connect With Us:
- Zoho Recruit Home
- Forums
- Connect With Us:
New to Zoho CRM Plus?
Deliver unforgettable customer experiences
New to Zoho CRM Plus?
Deliver unforgettable customer experiences
New to Zoho Marketing Plus?
Everything you need to run your marketing
New to Zoho Marketing Plus?
Everything you need to run your marketing
You are currently viewing the help pages of Qntrl’s earlier version. Click here to view our latest version—Qntrl 3.0's help articles.
New to Zoho Survey?
Zoho Sheet Resources
Zoho Forms Resources
New to Zoho Sign?
Zoho Sign Resources
Sign, Paperless!
New to Zoho TeamInbox?
Zoho TeamInbox Resources
New to Zoho ZeptoMail?
Zoho DataPrep Resources
Design. Discuss. Deliver.
New to Zoho Workerly?
New to Zoho Recruit?
New to Zoho CRM?
New to Zoho Projects?
New to Zoho Sprints?
New to Zoho Assist?
New to Bigin?
Related Articles
FAQs: Working on Tickets
What are Tickets Tabs in Zoho Desk? Tickets Tabs in Zoho Desk are designed to organize and provide contextual information about support tickets within the help desk system. These tabs enable users to connect tickets with other standard modules of ...Working with API Usage Alerts
API Usage Alerts allows users to receive notifications when the usage of API meets a specified threshold. Users can create alerts by limiting the threshold value and selecting the recipients of those notifications. This ensures that when the ...Understanding the Blueprints Dashboard
A support process is only effective when it’s adhered to, and when you know how each part is performing. As you streamline your support process using Blueprints, knowing whether it is implemented exactly as you’ve designed it and which parts need the ...Working With Dashboards
The Dashboard is a visual representation of the custom reports present in your Desk account. They provide a real-time snapshot of important business metrics that help in quick decision-making. Using dashboards, you can easily visualize the patterns ...Getting started with the IM Dashboard
Dashboard - One place to monitor all your Conversations Data A dashboard is where your customer-centric teams can see all business data in a single view. You can view all your customer conversations, discover insightful metrics, and organize outgoing ...
New to Zoho LandingPage?
Zoho LandingPage Resources