Recent searches


No recent searches

Managing API usage in your Zendesk account



image avatar

Charles Nadeau

Zendesk Documentation Team

Edited Jul 08, 2024


4

21

21 comments

Hi Daniel.

The API Rate limit on the Zendesk Support Professional plan is 400 requests per minute - you can see the rate limits for different plan levels here:

Plan Rate Limits

0


image avatar

Rudolph

Zendesk Luminary

@... - Is there any way to see larger time frames than just 24 hours? I'd like to see our API fire rate for the past 7 days.

Thanks!

2


Hi Rudolph, I don't think there's a way to monitor your rate limit beyond the most recent 24 hour timeframe. We do have some best-practices information on how to avoid running up against your rate limit, in case that helps: Best practices for avoiding rate limiting
 
If you'd like to see additional options for monitoring your API usage, please create a post in our Feedback - Platform: Apps & Integrations topic in the community forums, using this template so that our product team can better understand your use case. Thanks!

-1


Is there an API a support app can use to check if the rate limit has been reached? I am not able to receive the 429 too many requests signal in my app, it appears in the console but the actual call being paused gets no feedback until the limit is up and it completes. 

0


Hi Dave,
 
There's information about the current state of your rate limit in the API response headers – see Best practices for avoiding rate limiting

0


Hi Dave,

Thanks for that link, I see it demonstrates getting the headers via a curl, however using the following request can I receive these headers or error? I am not getting a 429 or any of this info in the response, but I might get it if I avoid using the client request?  

options = {
url:"/api/v2/tickets/" + this.ticketId + ".json",
type:"PUT",
contentType:"application/json",
data:'',
dataType:"json",
};
client.request(options); 

0


image avatar

Eric Nelson

Zendesk Developer Advocacy

Hey Dave,
 
You can receive these headers via zaf by adding in the httpCompleteResponse parameter. 
 
        options = {
url: "/api/v2/tickets/" + this.ticketId,
httpCompleteResponse: true,
type: "PUT",
contentType: "application/json",
data: JSON.stringify({
"ticket": {
"comment": {
"body": "Thanks for choosing Acme Jet Motors.",
"public": true
}
}
}),
dataType: "json",
};

0


Hello

How can I know the API Rate usage by endpoint?

Also is the Request Limit calculated base on the Average? or Peak requests?

Thanks

 

1


image avatar

Dane

Zendesk Engineering

Hi Alexandar,
 
For more information about API rate limits please refer to Usage limits. The normal rates will be based on calls per minute. 
 
Hope this helps!

0


Hi, 

Would it be possible to add the ability to monitor API activity beyond 24 hours? At the moment if you wanted to monitor stats like your peak API usage in an hour or a day, there's no real way to do this. This data is really useful for monitoring the effectiveness of add-ons like the "High Volume API", or it can allow you to notice trends around peak periods for API requests. 

6


The API dashboard is not helpful at all in monitoring API usage. While it shows the peak RPM usage, it is limited to 24 hours. It also doesn't provide any information on usage for the individual endpoint rate limits being reached; as these are different from the 400/700/whatever is included with the various plans. I view this dashboard daily and don't see an peak usage but it's clear that a rate limit is still being reached and there is no way to identify which one, when it occurs and how often.

Zendesk needs to give us better metrics to monitor these.

2


Hi,

It isn't good to have only 24 hours available on the monitor. Even worse, to be unable to check which API call has the most significant number of calls.

Currently, I'm opening tickets to Zendesk Support/Premier Team so they send me reports from Datadog. Not practical at all.

I understand the best practices and the workarounds, but it's a must-have regarding observability.

4


image avatar

Mike DR

Zendesk Customer Care

Hi Giancarlo! Totally understand your need and I would like to suggest submitting product feedback here: Feedback - Ticketing System (Support)

Our product team checks the requested features with the most votes and could possibly add that to future roadmaps.

0


Hi! The EAP has been enabled in our account for a couple of days, but we do not have any data.

 

Are there any other steps to take ? 

 

Thanks in advance

0


image avatar

Hiedi Kysther

Zendesk Customer Care

Hi ZD Bot, 

I've created a ticket on your behalf so we can investigate this together. Please keep an eye out on my email. 

Thanks! And, have a great day! 

0


The additional detail in the API Dashboard is great, really appreciate the work that the team put in there. It's certainly much easier to diagnose the source of problems using that information.

Allowing notifications (email/slack/teams etc.) to push a warning BEFORE you hit the limit would be an incredible additional piece here. That or enabling us to set up external monitoring tools would be a huge win.

0


image avatar

Lisa Kelly

Zendesk Documentation Team

Thank you for taking the time to provide us with your feedback here. I wanted to point you in the direction of our product feedback forum for Admin Center where we collect product feedback and where our PM’s review feedback from our customers. We would greatly appreciate you using this forum to share your feedback with us for better visibility. Here is our product feedback template to get you started. Thank you!

0


When will this feature be available in production?

0


This is a great step forward. However, we need to keep the ability to see usage by token (and vs. unauthenticated), which we could see in the legacy version.  Is this being added to the new dashboard and/or is the legacy version sticking around too?

3


image avatar

Shawna James

Community Product Feedback Specialist

Hey Alek, thank you so much for taking the time to provide us with your feedback here. I wanted to point you in the direction of our product feedback forum for Platform where we collect product feedback and where our PM’s review feedback from our customers. We would greatly appreciate you using this forum to share your feedback with us for better visibility. Here is our product feedback template to get you started. Thank you!

0


Agreed with the above note by Alek that usage by token, in particular 429 rate limit by token, is extremely needed.

Has a product feedback been filled already?

0


Please sign in to leave a comment.