Analysis

Analyze and summarize a plan run, saving the result. Generates/regenerates the summary.

Analyze and summarize a plan run and save the result. Call getSavedPlanRunFailureAnalysis before this endpoint, to use the prior saved response, if available.

post/analysis/{workspace_id}/planRun/summary

Request

  • Base URL: https://api.mabl.com
  • URL: https://api.mabl.com/analysis/{workspace_id}/planRun/summary
  • Auth: one of:
    • HTTP basic
    • API key in header Authorization

Path parameters

workspace_idstring required

The workspace associated with this plan run

Query parameters

regenerateboolean

Request regeneration of content, if saved analysis is already available

Request body

plan_run_idstring required

The ID of the plan run to analyze

save_summaryboolean

Whether to save the summary of the plan run analysis

Response

A summary of the analysis of the plan run

headlinestring

The short summary of the plan run analysis; typically limited to one sentence

summarystring

The summary of the plan run analysis

empty_response_reason'performance_only' | 'failing_tests_deleted' | 'precondition_failed'

(optional) The reason the analysis response is empty (e.g. All were performance tests)

Changes

No recorded changes to this operation across all 37 revisions of this API.