--- updatedAt: 2026-05-28T13:22:33.000Z agentTools: projectIndex: https://api.help.mabl.com/llms.txt --- # Get a plan run summary Retrieve detailed information about this plan run, including each of its test runs. # OpenAPI definition ```json { "openapi": "3.0.3", "info": { "title": "mabl API", "description": "APIs for interacting with mabl services", "version": "0.563.3-2026-10-09.1791576280-jbaldassari-1791576682-SNAPSHOT" }, "servers": [ { "url": "https://api.mabl.com/" } ], "components": { "securitySchemes": { "basicAuth": { "type": "http", "scheme": "basic" }, "bearerAuth": { "type": "apiKey", "name": "Authorization", "in": "header" } }, "schemas": { "TestRunResultSummaryBase": { "allOf": [ { "$ref": "#/components/schemas/BaseTestRunResult" }, { "properties": { "environment_id": { "type": "string", "description": "Environment ID", "readOnly": true }, "trigger_type": { "type": "string", "enum": [ "manual", "retry", "schedule", "customer_event", "insight" ], "description": "The type of trigger scheduling this test run", "readOnly": true }, "scenario_name": { "type": "string", "description": "Scenario name associated with this run, if any", "readOnly": true }, "branch": { "type": "string", "description": "Branch the test ran against, if any", "readOnly": true }, "application_name": { "type": "string", "description": "Application name", "readOnly": true }, "triggering_deployment_event_id": { "type": "string", "description": "Deployment event ID triggering this run, if any", "readOnly": true }, "test_version": { "type": "integer", "format": "int64", "description": "Test version", "readOnly": true }, "browser": { "type": "string", "description": "Browser in which this run was executed, if any", "readOnly": true }, "execution_runner_type": { "type": "string", "enum": [ "unified", "legacy", "performance_testing", "unknown" ], "description": "Execution runner used by this run", "readOnly": true }, "test_run_app_url": { "type": "string", "description": "URL for viewing the test run in the mabl app", "readOnly": true }, "browser_version": { "type": "string", "description": "Browser version, if any", "readOnly": true }, "workspace_name": { "type": "string", "description": "Workspace name", "readOnly": true }, "environment_name": { "type": "string", "description": "Environment name", "readOnly": true }, "test_run_id": { "type": "string", "description": "Test run ID", "readOnly": true }, "run_time": { "type": "integer", "format": "int64", "description": "The execution time of this test run (milliseconds)", "readOnly": true }, "failure_analysis": { "$ref": "#/components/schemas/FailureRootCauseAnalysis", "description": "Summary", "readOnly": true }, "end_time": { "type": "integer", "format": "int64", "description": "Time this test run ended (epoch milliseconds)", "readOnly": true }, "plan_labels": { "type": "array", "items": { "type": "string" }, "description": "Plan labels", "readOnly": true }, "application_id": { "type": "string", "description": "Application ID", "readOnly": true }, "plan_name": { "type": "string", "description": "Plan name, if any", "readOnly": true }, "plan_run_id": { "type": "string", "description": "Plan run ID, if any", "readOnly": true }, "start_time": { "type": "integer", "format": "int64", "description": "Time this test run started (epoch milliseconds)", "readOnly": true }, "emulation_mode": { "type": "string", "description": "Desktop or mobile web emulation used by this run", "readOnly": true }, "success": { "type": "boolean", "description": "True if the test run completed successfully", "readOnly": true }, "failure_category": { "type": "string", "description": "Failure category, if any", "readOnly": true }, "is_ad_hoc_run": { "type": "boolean", "description": "True if the run is a manually-triggered ad hoc run", "readOnly": true }, "metrics": { "$ref": "#/components/schemas/AdvancedMetrics", "readOnly": true }, "initial_url": { "type": "string", "description": "Starting URL for the test run", "readOnly": true }, "plan_id": { "type": "string", "description": "Plan ID, if any", "readOnly": true } } } ], "description": "Detailed information about a test run and its outcome that is common across test types", "type": "object" }, "ExternalTestCase": { "description": "External test case", "type": "object", "properties": { "id": { "type": "string", "description": "Id associated with this test case" } } }, "BaseTestRunResult": { "description": "Results of a test run", "type": "object", "properties": { "failure_summary": { "$ref": "#/components/schemas/TestRunFailureSummary", "description": "Contains supplemental information about test execution failure" }, "started_time": { "type": "integer", "format": "int64", "description": "Time test run was started, in epoch milliseconds" }, "test_cases": { "type": "array", "readOnly": true, "description": "User provided external test cases", "items": { "$ref": "#/components/schemas/ExternalTestCase" } }, "status_cause": { "type": "string", "description": "Cause for setting given status, such as failure cause. Updated in pairs with Status." }, "test_ref_id": { "type": "string", "description": "reference to this test in another system" }, "test_labels": { "type": "array", "items": { "type": "string" }, "description": "Test labels" }, "test_type": { "$ref": "#/components/schemas/TestTypeEnum" }, "workspace_id": { "type": "string", "description": "workspace Id" }, "execution_source": { "$ref": "#/components/schemas/TestSource" }, "completed_time": { "type": "integer", "format": "int64", "description": "Time test run was completed, in epoch milliseconds" }, "id": { "type": "string", "description": "Test run id" }, "journey_id": { "type": "string", "description": "(deprecated, use test_id) Test id", "readOnly": true }, "test_name": { "type": "string", "description": "Test name" }, "outcome": { "type": "string", "description": "The final outcome of this test run", "$ref": "#/components/schemas/TestRunResultOutcomeEnum" }, "test_id": { "type": "string", "description": "Test id", "readOnly": true }, "status": { "type": "string", "description": "The current status of this test run", "enum": [ "awaiting_precondition", "skipped", "rate_limited", "queued", "running", "completed", "failed", "terminating", "terminated" ] } } }, "AdvancedFlowMetrics": { "description": "Advanced flow metrics", "type": "object", "properties": { "accessibility_rule_violations": { "$ref": "#/components/schemas/RuleViolations", "readOnly": true }, "cumulative_speed_index": { "type": "number", "format": "double", "description": "Cumulative app load time in milliseconds across all the steps of a flow averaged across all flow instances", "readOnly": true }, "cumulative_speed_index_by_flow_instance": { "type": "array", "description": "Cumulative app load time in milliseconds across all the steps of a flow per instance", "items": { "type": "number", "format": "double" } }, "cumulative_api_response_time_by_flow_instance": { "type": "array", "description": "Cumulative API response time in milliseconds across all the steps of a flow per instance", "items": { "type": "number", "format": "double" } }, "cumulative_api_response_time": { "type": "number", "format": "double", "description": "Cumulative API response time in milliseconds across all the requests of an API flow averaged across all flow instances", "readOnly": true } } }, "TestTypeEnum": { "description": "Type of test", "type": "string", "enum": [ "api", "browser", "performance", "mobile" ] }, "TestRunResultSummary": { "allOf": [ { "$ref": "#/components/schemas/TestRunResultSummaryBase" }, { "description": "Detailed information about a test run and its outcome", "type": "object", "properties": { "metrics_by_flow": { "type": "array", "description": "Advanced metric by flow", "readOnly": true, "items": { "$ref": "#/components/schemas/AdvancedMetricsByFlow" } }, "performance_test_metrics": { "$ref": "#/components/schemas/PerformanceTestMetrics", "description": "Additional metrics for performance test runs", "readOnly": true } } } ] }, "ErrorResponseGeneric": { "properties": { "code": { "type": "integer", "format": "int32", "minimum": 100, "maximum": 599 }, "id": { "type": "string" }, "message": { "type": "string" } } }, "FailureRootCauseAnalysis": { "type": "object", "properties": { "summary": { "type": "string", "description": "The summary of the analysis for the run failure", "readOnly": true }, "evidence_details": { "type": "string", "description": "Agent-generated detailed evidence supporting the analysis, if available", "readOnly": true }, "failure_category_id": { "type": "string", "description": "The suggested failure category if applicable", "readOnly": true }, "headline": { "type": "string", "description": "The short summary of the run analysis; typically limited to one sentence", "readOnly": true } } }, "TestRunFailureSummary": { "description": "Information useful for diagnosing test run failures", "type": "object", "properties": { "step_number": { "type": "integer", "format": "int32", "description": "Step number within the flow where the failure occurred" }, "image_href": { "type": "string", "description": "URL of an image showing the error" }, "image_uri": { "type": "string", "description": "URL of an image showing the error" }, "flow_id": { "type": "string", "description": "ID of the flow in which the failure occurred" }, "flow_name": { "type": "string", "description": "Name of the flow in which the failure occurred, if any" }, "step_id": { "type": "string", "description": "ID of the step (with respect to the flow) where the failure occurred" }, "step_id_in_test": { "type": "string", "description": "ID of the step (with respect to the test) where the failure occurred" }, "error": { "type": "string", "description": "Unexpected error or formatted assertion failure that was recorded" }, "assert_failure": { "$ref": "#/components/schemas/AssertFailure", "description": "Assert failure details if test run failed due to an assertion failure" }, "image_artifact_url": { "type": "string", "description": "API url of the image that will redirect to a newly signed image url" } } }, "RuleViolations": { "description": "The count of accessibility rule violations per severity level", "type": "object", "properties": { "critical": { "type": "integer", "format": "int64", "description": "The count of critical rule violations by rule and page", "readOnly": true }, "minor": { "type": "integer", "format": "int64", "description": "The count of minor rule violations by rule and page", "readOnly": true }, "serious": { "type": "integer", "format": "int64", "description": "The count of serious rule violations by rule and page", "readOnly": true }, "moderate": { "type": "integer", "format": "int64", "description": "The count of moderate rule violations by rule and page", "readOnly": true } } }, "PlanRunResultSummary": { "description": "Detailed information about a plan run and its test runs", "type": "object", "properties": { "environment_id": { "type": "string", "description": "Environment ID", "readOnly": true }, "failure_analysis": { "$ref": "#/components/schemas/FailureRootCauseAnalysis", "description": "Summaries", "readOnly": true }, "trigger_type": { "type": "string", "description": "Type of trigger that caused this plan run", "enum": [ "manual", "retry", "schedule", "customer_event", "insight" ], "readOnly": true }, "plan_labels": { "type": "array", "items": { "type": "string" }, "description": "Plan labels", "readOnly": true }, "application_id": { "type": "string", "description": "Application ID", "readOnly": true }, "plan_name": { "type": "string", "description": "Plan name", "readOnly": true }, "workspace_id": { "type": "string", "description": "Workspace ID", "readOnly": true }, "plan_run_id": { "type": "string", "description": "Plan run ID", "readOnly": true }, "triggering_deployment_event_id": { "type": "string", "description": "Deployment event ID that triggered this plan run, if any", "readOnly": true }, "application_name": { "type": "string", "description": "Application name", "readOnly": true }, "success": { "type": "boolean", "description": "True if this plan run completed successfully", "readOnly": true }, "test_results": { "type": "array", "items": { "$ref": "#/components/schemas/TestRunResultSummary" }, "description": "Summaries for each test run in this plan run", "readOnly": true }, "workspace_name": { "type": "string", "description": "Workspace name", "readOnly": true }, "plan_id": { "type": "string", "description": "Plan ID", "readOnly": true }, "environment_name": { "type": "string", "description": "Environment name", "readOnly": true }, "status": { "type": "string", "description": "Current status of the plan run", "enum": [ "queued", "pre_execution", "scheduling", "scheduled", "succeeded", "failed", "cancelled", "post_execution", "completed", "terminated" ], "readOnly": true } } }, "TestRunResultOutcomeEnum": { "type": "string", "enum": [ "passed", "failed", "stopped" ] }, "TestSource": { "description": "Where the test lives", "type": "string", "enum": [ "mabl_cloud", "external", "mabl_local", "mabl_agent" ] }, "PerformanceTestMetrics": { "description": "Additional metrics for performance tests", "type": "object", "properties": { "api_error_rate_percent": { "type": "number", "format": "double", "description": "The average error rate [0-100] from performance test run", "readOnly": true }, "api_concurrent_user_count": { "type": "integer", "format": "int64", "description": "The number of concurrent users used by performance test run", "readOnly": true }, "api_requests_per_second": { "type": "integer", "format": "int64", "description": "The average requests per second from performance test run", "readOnly": true }, "api_virtual_user_hours_consumed": { "type": "number", "format": "double", "description": "The number of virtual user hours consumed by performance test run", "readOnly": true }, "api_average_response_time": { "type": "integer", "format": "int64", "description": "The average response time in milliseconds from performance test run", "readOnly": true } } }, "AdvancedMetricsByFlow": { "description": "Advanced metrics by Flow", "type": "object", "properties": { "flow_id": { "type": "string", "description": "Flow ID", "readOnly": true }, "flow_name": { "type": "string", "description": "Flow name", "readOnly": true }, "metrics": { "$ref": "#/components/schemas/AdvancedFlowMetrics", "readOnly": true } } }, "AssertFailure": { "description": "Details about assert failure", "type": "object", "properties": { "reason": { "type": "string", "description": "Assert failure description without expected/found values to eliminate the need for parsing downstream" }, "found": { "type": "string", "description": "Value actually found during test execution" }, "expected": { "type": "string", "description": "Expected value where applicable" } } }, "AdvancedMetrics": { "description": "Advanced metrics", "type": "object", "properties": { "accessibility_rule_violations": { "$ref": "#/components/schemas/RuleViolations", "readOnly": true }, "cumulative_speed_index": { "type": "number", "format": "double", "description": "Cumulative app load time in milliseconds across all the steps of a browser test", "readOnly": true }, "cumulative_api_response_time": { "type": "number", "format": "double", "description": "Cumulative API response time in milliseconds across all the requests of an API test", "readOnly": true } } } }, "responses": { "ErrorResponse": { "description": "Unknown error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseGeneric" } } } }, "ErrorResponse401": { "description": "User not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseGeneric" } } } }, "ErrorResponse403": { "description": "User not authorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseGeneric" } } } }, "ErrorResponse400": { "description": "Invalid or missing parameter", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseGeneric" } } } } } }, "security": [ { "basicAuth": [] }, { "bearerAuth": [] } ], "paths": { "/results/planRun/{plan_run_id}": { "get": { "summary": "Get a plan run summary", "operationId": "getPlanRunResult", "description": "Retrieve detailed information about this plan run, including each of its test runs.", "responses": { "200": { "description": "Plan run summary", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlanRunResultSummary" } } } }, "400": { "$ref": "#/components/responses/ErrorResponse400" }, "401": { "$ref": "#/components/responses/ErrorResponse401" }, "403": { "$ref": "#/components/responses/ErrorResponse403" }, "404": { "description": "The provided ID does not correspond to a plan run", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseGeneric" } } } }, "default": { "description": "Unexpected error", "$ref": "#/components/responses/ErrorResponse" } }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "plan_run_id", "description": "The plan run ID", "required": true }, { "schema": { "type": "boolean" }, "in": "query", "name": "advanced_metrics", "description": "Flag for whether to include advanced metrics like performance and accessibility in results", "required": false } ], "tags": [ "Reporting" ] } } }, "tags": [ { "name": "Reporting" } ] } ```