Reporting

Get test run summaries over a time range

Get results for a batch of test runs, with filtering available for time range, test/plan labels, test ID, plan ID, application ID, environment ID, and status.

get/results/workspace/{workspace_id}/testRuns

Request

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

Path parameters

workspace_idstring required

Workspace ID

Query parameters

application_idstring

Application ID

environment_idstring

Environment ID

test_idstring

Test ID

test_labelstring

Test label

plan_idstring

Plan ID

plan_labelstring

Plan label

outcomesTestRunResultOutcomeEnum[]

The result outcomes of test runs to include

earliest_run_start_timeinteger

Earliest test run start time in epoch milliseconds. The range from earliest_run_start_time to latest_run_start_time cannot exceed 400 days. Test runs are retained for 400 days, so earlier start times return no results. Required when latest_run_start_time is supplied; when both are omitted the most recent 30 days are returned.

latest_run_start_timeinteger

Latest test run start time in epoch milliseconds, defaulting to the current time. The range from earliest_run_start_time to latest_run_start_time cannot exceed 400 days.

advanced_metricsboolean

Flag for whether to include advanced metrics like performance and accessibility in results

limitinteger

Maximum number of runs to return in a single response. Additional pages of results can be retrieved by passing the cursor (returned in the results) on a subsequent call

cursorstring

Opaque pagination cursor returned by a previous call. Pass it back unchanged to fetch the next page; do not construct or modify it. A cursor is valid only for the same filters and time range; a value this endpoint did not return is rejected with HTTP 400.

Response

Test run results

workspace_idstring

Workspace ID

workspace_namestring

Workspace name

earliest_run_start_timeinteger

Beginning of the time range used to identify runs

latest_run_start_timeinteger

End of the time range used to identify runs

number_of_runsinteger

Number of runs in this page, equal to the length of test_results. This is not a total for the requested time range and can be smaller than limit, even zero, when a cursor is returned; follow cursor until it is absent to enumerate every run in the range. number_of_successful_runs and number_of_failed_runs do not necessarily sum to this value, because runs in any other status count toward neither.

number_of_successful_runsinteger

Number of runs in this page that completed successfully

number_of_failed_runsinteger

Number of runs in this page that failed

cursorstring

Opaque cursor for the next page, absent when there are no more results. Pass it unchanged as the cursor query parameter.

Changes

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