Announced on | Rollout starts | Rollout ends |
April 8, 2024 | April 8, 2024* | June 16, 2024 |
* Rollout for self-service customers will occur at a later date. |
This article includes these topics:
- What is changing?
- Default API usage limits
- About the API usage dashboard
- What does the dashboard offer?
- When is it available to me?
- What should I do if I’m over my rate limit?
- Where can I find more information?
What is changing?
Zendesk is always working to improve ease of use and provide additional product capabilities that will improve the admin experience. One challenge that companies have is understanding their API utilization. We are glad to announce the rollout of the API Usage Dashboard in Admin Center.
Default API usage limits
The API usage dashboard enables you to manage your default API usage limits and helps you increase your rate limits if needed.
Plan | Requests per minute |
---|---|
Team | 200 |
Growth | 400 |
Professional | 400 |
Enterprise | 700 |
High volume API add-on | 2500 |
* Enterprise Plus plans include the High Volume API add-on.
About the API usage dashboard
The dashboard provides greater insight into a customer's API utilization, helping customers better understand, what their overall API call rate looks like, how their API calls are trending compared to their plan limit and when and how frequently their implementation may be rate limited.
What does the dashboard offer?
7-day summary cards that display:
- % 429 errors - % of requests that have been rate limited (429s),
- Limit near-breaches - the number of times within 7 days that the overall came within 90-99% of the plan limit.
- Limit approaches - the number of times within 7 days that the overall usage came within 80-89% of the plan limit.
- Time series view detailing the total number of requests and rate limited calls.
- Color coded quick view usage information cards that detail storage and file usage to date.
- Ability to select a custom range up to the last 90 days and get a daily, weekly or monthly view.
- Ability to see the top 5 callers by volume and their error rate.
- Ability to see the top 5 endpoints called by volume, how many are successful, the overall error rate and the number of calls rate limited.
- Ability to see the top 5 endpoints by % of rate limited calls.
When is it available to me?
We’re working to roll this out automatically to all Zendesk customers in H1 2024. Once made available on your account, the dashboard will be accessible from Admin Center.
What should I do if I’m over my rate limit?
If you find that your instance is being frequently rate limited:
- Check your plan to confirm your current API rate limit.
- Use the dashboard to better identify which API caller(s) and API endpoint(s) are being rate limited the most.
- Where possible, perform an internal investigation to better understand who is calling which of these endpoints. Also try to understand when and why they may be being called more frequently than the rate limit allows.
- Zendesk is here to help. Reach out to your Zendesk Sales representative to request ways to get a consultation on your API implementation and discuss purchasing our High Volume API add-on. You need a Suite Growth plan or above (or a Support Professional plan or above) to purchase it.
Where can I find more information?
More information about managing your API usage can be found in this help center article.
If you have feedback or questions related to this announcement, visit our community forum where we collect and manage customer product feedback. For general assistance with Zendesk products, contact Zendesk Customer Support.