This week's release of Time in Status by OBSS for Jira Cloud introduces two new REST endpoints that allow clients to get TiS report data with a single REST request.
TiS reports process not only Jira issues but their histories as well. Because of this, reports can take a significant time to complete, especially for large data sets. On the other hand, HTTP requests have a 60-second default timeout so it is not possible to get, with a single REST request, any TiS report that takes longer than 60 seconds.
For this reason, until today, TiS REST API only supported asynchronous file exports. In this way of using the REST API, the client sends a REST Request to start an export, uses another REST request to track the progress of the export (while the export is running on our server), and when completed uses yet another REST request to get the result file. This makes sure that the process is not interrupted by timeouts and the client can get reports with as many issues as needed.
On the other hand, customer demand and analysis of our service logs revealed that most TiS file exports were using small issue sets and were finished in under 60 seconds. So they wouldn't be interrupted by timeouts.
Based on this revelation, we built two new REST endpoints for the TiS service.
These endpoints return aggregation data (average, sum, median, stddev) and file exports with a single REST call respectively. While using these endpoints, there is no need to make multiple calls to get the results of a single TiS report.
These endpoints are of course still limited by HTTP timeouts so for any report request that will take longer than 60 seconds, the asynchronous file export endpoints are still available.
The documentation for TiS REST API can be foundhere.
If you have any questions or suggestions about anything, you can always reach our friendly support teamhere.
7.19.21, themed by Refined
Single Request report data endpoints for Time in Status for Jira Cloud
This week's release of Time in Status by OBSS for Jira Cloud introduces two new REST endpoints that allow clients to get TiS report data with a single REST request.
TiS reports process not only Jira issues but their histories as well. Because of this, reports can take a significant time to complete, especially for large data sets. On the other hand, HTTP requests have a 60-second default timeout so it is not possible to get, with a single REST request, any TiS report that takes longer than 60 seconds.
For this reason, until today, TiS REST API only supported asynchronous file exports. In this way of using the REST API, the client sends a REST Request to start an export, uses another REST request to track the progress of the export (while the export is running on our server), and when completed uses yet another REST request to get the result file. This makes sure that the process is not interrupted by timeouts and the client can get reports with as many issues as needed.
On the other hand, customer demand and analysis of our service logs revealed that most TiS file exports were using small issue sets and were finished in under 60 seconds. So they wouldn't be interrupted by timeouts.
Based on this revelation, we built two new REST endpoints for the TiS service.
/aggregation
/smallexport
These endpoints return aggregation data (average, sum, median, stddev) and file exports with a single REST call respectively. While using these endpoints, there is no need to make multiple calls to get the results of a single TiS report.
These endpoints are of course still limited by HTTP timeouts so for any report request that will take longer than 60 seconds, the asynchronous file export endpoints are still available.
The documentation for TiS REST API can be found here.
If you have any questions or suggestions about anything, you can always reach our friendly support team here.
Emre TOPTANCI