PlanRun

Aggregate plan run counts for a workspace (fast Datastore counts)

Changed on

Returns total plan runs and counts grouped into normalized status buckets for the workspace, optional environment/application filters, and created_time range. Uses server-side aggregation (not full listing). Newest failing plan runs and top plans by failure count are derived from a bounded sample of recent failures when failures exist. Ad-hoc runs (single test runs launched outside any plan) are excluded from all counts and samples.

get/planRuns/workspace/{workspace_id}/aggregate

Request

  • Base URL: https://api.mabl.com
  • URL: https://api.mabl.com/planRuns/workspace/{workspace_id}/aggregate
  • Auth: one of:
    • HTTP basic
    • API key in header Authorization

Path parameters

workspace_idstring required

The workspace (organization) id

Query parameters

environment_idstring
application_idstring
min_created_timeinteger

Inclusive lower bound on created_time (epoch ms)

max_created_timeinteger

Inclusive upper bound on created_time (epoch ms)

failed_plan_run_sample_limitinteger

Max newest failed plan runs to return (0 skips). Default 20, max 150 — same bounds as PlanRunServiceImpl and the results-analysis overview tool.

Response

Aggregated workspace plan run statistics

total_plan_runsinteger required
scan_completeboolean required

True when aggregate counts cover the full filter (always true for this endpoint)

stopped_earlyboolean required

Reserved; false for aggregation-based implementation

failures_sampled_for_top_plansinteger required

Number of newest failed runs scanned to compute top_plans_by_failed_runs

top_plans_exhaustiveboolean required

True when every failed run in range was included in the top-plan sample

Changes

  • 67dadb3fba24Revision changes
    • info

      added the optional property // to the response with the status

  • 0ddfcf08c4a8Revision changes
    • info

      added the optional property // to the response with the status