CHchrt
/tracking

List

Changed on

Lists sessions with filtering, sorting, and pagination. Use org_scope to restrict to owned, shared, or both (default). | auth: api_key | authz: min_org_role=operator | () -> (SessionListRes)

get/tracking/sessions/list/v1

Request

  • Base URL
    http://localhost:8000
  • URL
    http://localhost:8000/tracking/sessions/list/v1
  • Auth
    HTTP bearer

Query parameters

sort_by'created_at_timestamp' | 'last_seen_at_timestamp' | 'termination_scheduled_for_timestamp' | 'terminated_at_timestamp'

Field to sort by

sort_order'asc' | 'desc'

Sort order for query results

Sort order (asc or desc)

pageinteger
page_sizeinteger
searchstring nullable

Full-text search query

org_scope'owned' | 'shared' | 'owned_and_shared'

Filter by org ownership: owned, shared, or owned_and_shared

filter_session_idsstring[] nullable

Filter by selected session ids

filter_terminatedboolean nullable

Filter by terminated status

filter_publicboolean nullable

Filter by public visibility

filter_device_idstring nullable

Filter by device ID

filter_off_chrt_reference_idstring nullable

Must be a URL-safe string of 1-64 characters. Allowed characters: A-Z, a-z, 0-9, '.', '_', '~', '-' (RFC 3986 unreserved).

Filter by off-CHRT reference ID (exact match)

filter_flight_numberstring nullable

Filter by flight number (exact match)

filter_flight_loaded_statusstring nullable

Filter by flight loaded status (exact match)

filter_has_last_seenboolean nullable

Filter by whether both last_seen_at_location and last_seen_at_timestamp are set

filter_created_at_timestamp_gtestring date-time nullable

Filter by created_at_timestamp >= value

filter_created_at_timestamp_ltestring date-time nullable

Filter by created_at_timestamp <= value

filter_last_seen_at_timestamp_gtestring date-time nullable

Filter by last_seen_at_timestamp >= value

filter_last_seen_at_timestamp_ltestring date-time nullable

Filter by last_seen_at_timestamp <= value

filter_termination_scheduled_for_timestamp_gtestring date-time nullable

Filter by termination_scheduled_for_timestamp >= value

filter_termination_scheduled_for_timestamp_ltestring date-time nullable

Filter by termination_scheduled_for_timestamp <= value

filter_terminated_at_timestamp_gtestring date-time nullable

Filter by terminated_at_timestamp >= value

filter_terminated_at_timestamp_ltestring date-time nullable

Filter by terminated_at_timestamp <= value

Response

Successful Response

total_countinteger required

Changes