Reporting
The Cutover API is a great way to extract critical information about your runbooks, tasks and much more. We have a number of API calls that will allow you to pull this data directly from Cutover. We have many dashboards within the Cutover user interface and you can use the API to build your own reporting and dashboards.
Solution
The Cutover API is not a reporting tool but the data is extractable for you to use to provide greater visibility to your internal stakeholders. Ultimately, you can leverage business intelligence and reporting tools to pull in Cutover data to provide great visualizations. A good example of this is to use our runbook API’s to build your own RTO and RTA dashboard. What does RTO and RTA actually mean? RTO is the period of time that is defined by an organisation to restore an affected service. RTA is the actual time taken to restore a service or perform data recovery. The Cutover API has the capability for you to calculate both.
Recipe
Our customers can have specific internal and external reporting needs and Cutover has many dashboards that provide critical real-time data. By using our extensive Cutover API, our customers are able to create their own reports. One such example is a RTO/RTA report. Let’s get started with the recipe:
1. Execute the Get a Runbook API and store the start_planned attribute of your Runbook as a variable.
Note: An API request will be required for each runbook that requires an RTO and RTA.
2. Using the Runbook ID identified in step 1, perform a GET request to List tasks in a Runbook. The API will retrieve information regarding your tasks including any application task you may want to report on. Please store the end_planned attribute from your application task.
3. In order to calculate the RTO, use the end_planned and the start_planned returned in step 1 and 2 to do the following calculation:
Planned finish time of the application task minus the planned start time of the runbook.
4. Once your application runbook has been completed in a live run, locate the application task using the List Tasks in a Runbook API. You will need to store the end_actual attribute.
5. Execute the Get a Runbook endpoint and store the start_actual attribute as a variable.
6. In order to calculate the RTA, use the end_actual and the start_actual returned in step 4 and 5 to do the following calculation:
Actual finish time of the application task minus the start time of the runbook.
Available endpoints
This endpoint breaks down each individual task associated with a runbook.
This endpoint retrieves runbook level information. You can use parameters to return all runbooks associated with a workspace, folder or even the stage the runbooks are at.
