Returns
Returns a list of Session objects.Example
Parameters
The ID or IDs of the dataset(s) to filter sessions by.
Deprecated alias:
test_id.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.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.Number of sessions to skip before starting to collect results. Use for pagination.Default:
0 (start from the beginning)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.Filter by the ID of the user who launched the session. A production session has no launcher and never matches this filter. A session ingested from OpenTelemetry traces is production too, unless its spans name a test case; that one records the user of the API key that sent the traces, so it does match. This is an additional filter; it does not satisfy the scoping requirement below.
At least one of the scoping filters (
version_id, test_case_id, custom_id, dataset_id, id) described above must be passed to the method. status and user_id are additional filters and do not satisfy this requirement on their own.