List | Chrt

import { ChrtClient } from "@chrt-inc/typescript-sdk";
async function main() {
    const client = new ChrtClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.tracking.sessions.listV1({
        sort_by: "created_at_timestamp",
        sort_order: "asc",
        page: 1,
        page_size: 1,
        search: "search",
        org_scope: "owned",
        filter_terminated: true,
        filter_public: true,
        filter_device_id: "filter_device_id",
        filter_off_chrt_reference_id: "filter_off_chrt_reference_id",
        filter_flight_number: "filter_flight_number",
        filter_fa_flight_id: "filter_fa_flight_id",
        filter_flight_loaded_status: "filter_flight_loaded_status",
        filter_created_at_timestamp_gte: "2024-01-15T09:30:00Z",
        filter_created_at_timestamp_lte: "2024-01-15T09:30:00Z",
        filter_termination_scheduled_for_timestamp_gte: "2024-01-15T09:30:00Z",
        filter_termination_scheduled_for_timestamp_lte: "2024-01-15T09:30:00Z",
        filter_terminated_at_timestamp_gte: "2024-01-15T09:30:00Z",
        filter_terminated_at_timestamp_lte: "2024-01-15T09:30:00Z",
    });
}
main();

{
  "items": [
    {
      "schema_version": 1,
      "device_id": "device_4567",
      "device_mac_address": "00:1A:2B:3C:4D:5E",
      "org_id": "org_123456",
      "created_at_timestamp": "2024-01-10T08:00:00Z",
      "_id": "session_abc123xyz",
      "off_chrt_reference_id": "REF_12345_ABC",
      "comments": "Container arrived damaged, inspection required.",
      "public": true,
      "off_chrt_shipper_org_id": "shipper_org_789",
      "termination_scheduled_for_timestamp": "2024-01-15T09:30:00Z",
      "flight_numbers": [
        "AA1234"
      ],
      "fa_flight_ids": [
        "FA987654321"
      ],
      "shared_with_org_ids": [
        "org_654321"
      ],
      "terminated": true,
      "terminated_at_timestamp": "2024-01-15T09:30:00Z",
      "fa_alert_ids": [
        1024
      ],
      "flight_loaded_statuses": [
        "loaded"
      ],
      "fa_alert_id_by_flight_number": {
        "AA1234": 1024
      },
      "flight_status_by_fa_flight_id": {
        "FA987654321": "landed"
      }
    }
  ],
  "total_count": 1
}

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)

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

sort_byenumOptional

Field to sort by

Allowed values:

sort_orderenumOptional

Sort order (asc or desc)

Allowed values:

pageintegerOptional>=1Defaults to 1

page_sizeintegerOptional1-100Defaults to 20

searchstringOptional

Full-text search query

org_scopeenumOptional

Filter by org ownership: owned, shared, or owned_and_shared

Allowed values:

filter_terminatedbooleanOptional

Filter by terminated status

filter_publicbooleanOptional

Filter by public visibility

filter_device_idstringOptional

Filter by device ID

filter_off_chrt_reference_idstringOptionalformat: "^[A-Za-z0-9._~\-]{1,64}$"1-64 characters

Filter by off-CHRT reference ID (exact match)

filter_flight_numberstringOptional

Filter by flight number (exact match)

filter_fa_flight_idstringOptional

Filter by FlightAware flight ID (exact match)

filter_flight_loaded_statusstringOptional

Filter by flight loaded status (exact match)

filter_created_at_timestamp_gtedatetimeOptional

Filter by created_at_timestamp >= value

filter_created_at_timestamp_ltedatetimeOptional

Filter by created_at_timestamp <= value

filter_termination_scheduled_for_timestamp_gtedatetimeOptional

Filter by termination_scheduled_for_timestamp >= value

filter_termination_scheduled_for_timestamp_ltedatetimeOptional

Filter by termination_scheduled_for_timestamp <= value

filter_terminated_at_timestamp_gtedatetimeOptional

Filter by terminated_at_timestamp >= value

filter_terminated_at_timestamp_ltedatetimeOptional

Filter by terminated_at_timestamp <= value

Response

Successful Response

itemslist of objects

total_countinteger

Errors

422

Sessions List V1request Unprocessable Entity Error