v4

latestOpenAPI 3.0.1Apache 2.02026-07-312457525.9 MB

Unit Test API

Get a specific test session

get/workspaces/{workspace_domain}/projects/{project_name}/unit-tests/suites/{suite_id}/sessions/{id}

Path parameters

workspace_domainstring required

Example:my-company

The human-readable ID of the workspace

project_namestring required

Example:my-project

The human-readable ID of the project

suite_idstring required

Example:MNbyVedg

The ID of the unit test suite

idstring required

Example:r4nBYXVq

The ID of the test session

Response

urlstring

API endpoint to GET this object

html_urlstring

Web URL to view this object in Buddy.works

idinteger

Unique identifier of the test session

relative_idinteger

Sequential ID within the suite

create_datestring date-time

Timestamp when the session was created

start_datestring date-time

Timestamp when the session started

finish_datestring date-time

Timestamp when the session finished

ci_provider'NONE' | 'BUDDY' | 'GITHUB_ACTION' | 'CIRCLE_CI'

CI provider that initiated the test session

ci_run_urlstring

URL to the external CI/CD run

revisionstring

Ending revision/commit hash for the test range

ref_type'BRANCH' | 'TAG' | 'PULL_REQUEST'

Type of Git reference

ref_namestring

Name of the Git reference (branch name, tag name, etc.). May be null if ref_type is not provided.

execution_idstring

Execution hash ID. Set when session is a result of BUDDY action execution

action_execution_idstring

Action execution hash ID. Set when session is a result of BUDDY action execution

status'IN_PROGRESS' | 'SUCCESSFUL' | 'ERROR' | 'SKIPPED'

Current status of the session

error_messagestring

Error message if the session failed. Set when status is ERROR.

durationinteger

Total duration in seconds

tests_countinteger

Total number of tests

failed_countinteger

Number of failed tests

skipped_countinteger

Number of skipped tests

error_countinteger

Number of tests with errors