Sign in

v18

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-014211,6201.8 MB
gitpod.v1.WorkflowService

GetWorkflowExecutionSummary

Returns aggregate counts of workflow executions within a time range.

Use this method to:

  • Get a summary of successful, failed, and total executions
  • Build dashboard views of automation activity

Examples

  • Get execution summary for the last 7 days:

    filter:
  dateRange:
    startTime: "2026-03-05T00:00:00Z"
    endTime: "2026-03-12T00:00:00Z"

  • Get execution summary for specific workflows:

    filter:
  dateRange:
    startTime: "2026-03-01T00:00:00Z"
    endTime: "2026-03-12T00:00:00Z"
  workflowIds: ["b0e12f6c-4c67-429d-a4a6-d9838b5da047"]
post/gitpod.v1.WorkflowService/GetWorkflowExecutionSummary

Request body

Response

Success

failedCountstring

Number of failed executions: COMPLETED with failed_action_count > 0, or STOPPED with failed_action_count > 0 or a non-empty failure_message (matches dashboard "Failed" labeling).

successfulCountstring

Number of executions in COMPLETED phase with no failed actions (failed_action_count == 0).

totalCountstring

Total number of executions in the time range, regardless of phase.

totalWorkflowsInOrganizationstring

Total number of workflows that exist in the organization. This count is independent of the date range filter.