Returns
Returns a list of Session objects.Example
Parameters
string | list[string]
The ID or IDs of the version(s) to filter sessions by.
string | list[string]
The ID or IDs of the test case(s) to filter sessions by.
string | list[string]
The custom ID or IDs to filter sessions by.
string | list[string]
The ID or IDs of the test(s) to filter sessions by.
str | int
default:"None"
Filter sessions created at or after this timestamp. Accepts ISO 8601 string (e.g.,
'2024-01-01T00:00:00Z') or Unix timestamp in seconds. Can be used independently or together with to_created_at.str | int
default:"None"
Filter sessions created at or before this timestamp. Accepts ISO 8601 string (e.g.,
'2024-12-31T23:59:59Z') or Unix timestamp in seconds. Can be used independently or together with from_created_at.string
Sort sessions by creation date. Valid values are “asc” and “desc”.
int
default:"0"
Number of sessions to skip before starting to collect results. Use for pagination.Default:
0 (start from the beginning)int
default:"10000"
Maximum number of sessions to return in a single request.Default:
10000string | list[string]
default:"None"
The ID or IDs of the session(s) to retrieve.
string | list[string]
default:"None"
Filter sessions by status. Valid values are
PENDING, COMPLETED, and FAILED. Accepts a single value or a list of values (results are OR-combined). Other string values are sent to the API unchanged, so values added in newer API versions can be used; the API rejects invalid ones.At least one of the scoping filters (
version_id, test_case_id, custom_id, test_id, id) described above must be passed to the method. status is an additional filter and does not satisfy this requirement on its own.