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.

Get tests explorer

get
/tests/{projectId}

Get aggregated test metrics for a project within a date range

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: 1Optional

Maximum number of items to return (default: 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"]
branches[]string[]Optional

Filter by branches (can be specified multiple times using bracket notation, e.g., branches[]=main&branches[]=develop)

Example: ["main","develop"]
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

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_settingsstringOptional

Override which test statuses are included in metric calculations. Pass a JSON object with optional keys: executions, avgDuration, flakinessRate, failureRate. Each value is an array of status strings: passed, failed, pending, skipped. Omitted keys use defaults. Example: {"executions":["failed","passed"],"failureRate":["failed"]}

Example: {"executions":["failed","passed"],"failureRate":["failed"]}
Responses
chevron-right
200

Successful response

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

Last updated

Was this helpful?