Retrieving execution summary

Retrieve the execution summary based on the provided search parameters.

1. In your REST client, configure the authentication credentials for the tenant whose execution summary you want to retrieve.

   
   //In case of Instance API key 
   Headers:
   {
   "x-instance-api-key": "instance_api_key"
   }
    
   // In case of MCSP or ISV token
   Headers:
   {
   "Authorization": "mcsp_or_isv_token"
   }
   Body: 
   {
       "start_date": "<execution_start_timestamp>",
       "end_date": "<execution_stop_timestamp>",
       "projects": <list of project names/uids>,
       "workflows": <list of workflow uids>,
       "execution_status": <list of execution status>, // should be one of ['running', 'success', 'failed', 'timeout', 'pending'/'queued', 'hold', 'stopped']
       "context_id": "<context_id>" // must be a string
   }
   

   Note: Only the start_date and end_date are mandatory fields. All other fields are optional. The start_date and end_date should be in ISO-8601 format like 2023-12-20 or 2023-12-20T00:00:00Z. Only the requested execution statuses are included in the response. If more than one execution status is requested, the response will include a total field containing the sum of all selected execution statuses.
2. Make a POST request to the API endpoint.

   URL Syntax: <domain>/apis/v1/rest/monitor/summary

   Pagination parameters can be provided as query parameters:

   URL Syntax: <domain>/apis/v1/rest/monitor/summary?skip=<offset>&limit=<page_size>

   skip: The number of execution records to skip before returning results.

   limit: The maximum number of execution records to return in the response (maximum 150).

   Note: If skip and limit are not specified, the API returns the first set of execution logs (up to 150).

   Method: POST

   If the request is successful, a success response code is returned.

   {
       "output": {
           "summary": {
               "success": <success_log_count>,
               "running": <running_log_count>,
               "stopped": <stopped_log_count>,
               "failed": <failed_log_count>,
               "timeout": <timeout_log_count>,
               "queued": <queued_log_count>,
               "hold": <hold_log_count>,
               "total": <total_count_of_all_statuses>
           },
           "graph": {
               "count": <total_count_of_all_fetched_logs>,
               "logs": [
                   {
                       "uid": <bill_uid>,
                       "execution_status": <execution_status>,
                       "flow_name": "<flow_name>",
                       "flow_uid": <flow_uid>,
                       "project_uid": "<project_uid>",
                       "restarted": <is_restarted>,
                       "requested_at": <requested_at>,
                       "project_name": <project_name>,
                       "execution_source": <execution_source>,
   					"restarted_from": "<bill_uid>",
   					"restart_history": [],
   					"context_id": "<context_id>"
                   },               
                   {
                       "uid": <bill_uid>,
                       "execution_status": <execution_status>,
                       "flow_name": "<flow_name>",
                       "flow_uid": <flow_uid>,
                       "project_uid": "<project_uid>",
                       "restarted": <is_restarted>,
                       "requested_at": <requested_at>,
                       "project_name": <project_name>,
                       "execution_source": <execution_source>,
   					"restarted_from": "<bill_uid>",
   					"restart_history": [],
   					"context_id": "<context_id>"
                   }
               ]
           }
       }
   

   Note:

   • A maximum of 150 logs can be fetched per API call.

   • For the metrics API, start_date and end_date are considered in UTC.

   • All timestamps in the response are returned in UTC.