Tests Explorer

Explore and analyze test metrics.

The Tests Explorer provides aggregated metrics for tests within a project, including execution counts, failure rates, flakiness rates, and duration statistics.

Outcome strings are defined in the RecordedTestOutcome schema (see components/schemas). That schema explains how each value maps to metrics on GET /tests/{projectId} (ignored, failures, etc.).

Narrative context for the dashboard is here: Test result statuses — Tests Explorer & REST APIarrow-up-right.

Get tests explorer

get
/tests/{projectId}

Get aggregated test metrics for a project within a date range. Outcomes use the RecordedTestOutcome schema (see components/schemas). For narrative context, see the Test result statusesarrow-up-right section on the Test Explorer documentation page.

Authorizations
AuthorizationstringRequired

API key authentication using Bearer token

Path parameters
projectIdstringRequired

The project ID

Example: proj_abc123
Query parameters
date_startstring · date-timeRequired

Start date in ISO 8601 format

Example: 2024-01-01T00:00:00.000Z
date_endstring · date-timeRequired

End date in ISO 8601 format

Example: 2024-01-31T23:59:59.999Z
pageintegerOptional

Page number (0-indexed)

Default: 0
limitinteger · min: 1 · max: 50Optional

Maximum number of items to return (default: 50, max: 50)

Default: 50
tags[]string[]Optional

Filter by tags (can be specified multiple times using bracket notation, e.g., tags[]=value1&tags[]=value2)

Example: ["tag1","tag2"]
groups[]string[]Optional

Filter by groups (can be specified multiple times using bracket notation, e.g., groups[]=group1&groups[]=group2)

Example: ["group1","group2"]
authors[]string[]Optional

Filter by git authors (can be specified multiple times using bracket notation, e.g., authors[]=author1&authors[]=author2)

Example: ["author1","author2"]
orderstring · enumOptional

Field to order results by

Default: titlePossible values:
dirstring · enumOptional

Sort direction: desc (default) or asc.

Default: descPossible values:
specstringOptional

Filter tests by spec file name (partial match)

titlestringOptional

Filter tests by title (partial match)

min_executionsinteger · min: 1Optional

Minimum number of executions to include

metric_settingsanyOptional

Overrides which outcomes feed each metric. Keys: executions, avgDuration, flakinessRate, failureRate — each value is an array of RecordedTestOutcome. Omitted keys use defaults. Pass as a JSON value (same encoding as content: application/json for this parameter).

annotationsstringOptional

Filter by test annotations. The parameter value must be a JSON-stringified array of objects: [{ "type": "string", "description": "string" | ["string"] or null }]. description is optional; omit or set to null to match any value for that annotation.

Example: [{"type":"owner","description":["John Doe"]},{"type":"skip"}]
Responses
chevron-right
200

Successful response

application/json
statusstring · enumRequiredPossible values:
get
/tests/{projectId}

Last updated

Was this helpful?