Best Practices for Tempo Cloud REST API

Follow these instructions before you pull massive data into any 3rd party apps, such as eazyBI or PowerBI, either from Cloud to Cloud or Cloud to Server.

 Instructions

Currently, the Tempo API gateway has a rate limit of 5 requests per second, regardless of the connection types: Application access, user token, or OAuth2 connection. The largest dataset stored in Tempo is from worklogs. The number of results returned is based on your REST call parameters, so try to avoid getting months of worklogs in one single call. Instead, it’s recommended to write a script to loop through user/issue/week with pagination for better network traffic and server performance. You can narrow down your query with the following parameters:

1. Use a shorter time frame, such as by day or by week (instead of by month)

2. Use a single user (instead of teams)

3. Use pagination

4. Use a limit (maximum: 1000 for REST API V3, 5000 for REST API V4)

Do’s and Don’ts:

1. Test out your script to make sure there are no errors.

2. Monitor your usage for timeouts (1 second or more) and retries (maximum 3 times).

3. Have no more than 5 requests per second

4. Max 3 batches of 5r/s running in parallel (5r/s * 3 = 15r/s) by memory zone of 10mb

5. Wait at least 1000ms between each request.

API error codes and retry recommendation

 Related articles