Sign in

v2

latestOpenAPI 3.0.02026-07-261859071.2 MB
Test sessions

List test sessions

Retrieves test sessions for the selected account. Use the optional query parameters to filter by creation time, status, branch, user, provider, text, or error group.

get/v1/test-sessions

Query parameters

fromnumber

Only include test sessions created at or after this Unix timestamp.

Only include test sessions created at or after this Unix timestamp.

tonumber

Only include test sessions created before this Unix timestamp.

Only include test sessions created before this Unix timestamp.

limitinteger nullable

Maximum number of test sessions to return.

Maximum number of test sessions to return.

statusesstring[]

Filter by test session status.

Filter by test session status.

branchesstring[]

Filter by Git branch name.

Filter by Git branch name.

usersstring[]

Filter by commit owner or invoking user ID.

Filter by commit owner or invoking user ID.

providersstring[]

Filter by test session provider.

Filter by test session provider.

noUsersboolean

Include sessions with no commit owner and no invoking user.

Include sessions with no commit owner and no invoking user.

nextIdstring

Opaque cursor returned from a previous list response.

Opaque cursor returned from a previous list response.

textSearchstring

Search test session text fields.

Search test session text fields.

errorGroupIdstring nullable

Filter by test-session error group ID.

Filter by test-session error group ID.

Headers

x-checkly-accountstring uuid

Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general

Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general

Response

Successful

lengthinteger required
nextIdstring nullable