Interactions with Zendesk API

Put simply, an application programming interface (API) is a way for applications to communicate with each other. In this article, you will find information on how to estimate the number of API calls tymeshift makes, compare that number to the actual calls made during a specific time, and get access to our API documentation for data integration with your other tools. 

• Identify Zendesk API Endpoints used by tymeshift
• Estimate how many Zendesk API calls tymeshift makes
• Generate an API Report

Identify Zendesk API Endpoints used by tymeshift

The table below outlines which Zendesk API endpoints tymeshift uses and why.

Below is a list of the information tymeshift stores in our database from the Zendesk endpoints above:

• Ticket IDs/Chat IDs
• Ticket Events (Ticket Solved, Status Changed, etc.)
• Agent Profile Name
• Agent Email Address
• Talk Status (Available, Unavailable, Wrap Up, On Call)
• Zendesk Account URL
• Satisfaction Ratings 

Estimate how many Zendesk API calls tymeshift makes

Zendesk limits the number of concurrent API calls that can be made each minute to your Zendesk account. This is a global limit that applies to all of the apps you have installed as well as internal services that utilize the Zendesk App. Thus, it's important to understand the API usage of each service or application that is connected to your API to ensure your account remains under the API limit.

Use this calculator to estimate how many API calls will be used by tymeshift.

Note: in addition to this estimator, we track the actual number of API calls in our API Report (details in the next section).

You may also want to check out the following resources about API limits and API call monitoring:

• Zendesk's API rate limits by plan
• Monitoring your total API requests using Zendesk

• Generate an API Report

  tymeshift provides an API Report which tracks API calls that are specific to tymeshift. This can be helpful in understanding how many API calls tymeshift makes to your Zendesk account as well as a useful tool to diagnose problems if you are exceeding your rate limit.

  You can access this report by following these steps:

  1. Go to Admin 

  2. Select Settings 

  3. Chose Show Advanced Options

  4. Click on API Usage Report

  In the report, you will be able to select the exact date you want to see API results for, and the chart's legend will break down the types of API requests. The chart represents the total number of API calls made within a specific hour (numbers above each bar are the average of API calls per minute).