Get

GET

/tracking/sessions/get/v1

GET

/tracking/sessions/get/v1

1 import { ChrtClient } from "@chrt-inc/typescript-sdk";
2 
3 async function main() {
4     const client = new ChrtClient({
5         token: "YOUR_TOKEN_HERE",
6     });
7     await client.tracking.sessions.getV1({
8         session_id: "session_id",
9     });
10 }
11 main();

1 {
2   "schema_version": 1,
3   "device_id": "device_4567",
4   "device_mac_address": "00:1A:2B:3C:4D:5E",
5   "org_id": "org_123456",
6   "created_at_timestamp": "2024-01-10T08:00:00Z",
7   "_id": "session_abc123xyz",
8   "off_chrt_reference_id": "REF12345_ABC",
9   "comments": "Package delayed due to weather conditions at origin airport.",
10   "public": true,
11   "off_chrt_shipper_org_id": "shipper_org_789",
12   "termination_scheduled_for_timestamp": "2024-01-15T09:30:00Z",
13   "flight_numbers": [
14     "AA1234"
15   ],
16   "fa_flight_ids": [
17     "FA987654321"
18   ],
19   "shared_with_org_ids": [
20     "org_654321",
21     "org_789012"
22   ],
23   "terminated": true,
24   "terminated_at_timestamp": "2024-01-15T09:30:00Z",
25   "last_seen_at_location": {
26     "type": "Feature",
27     "geometry": {
28       "type": "GeometryCollection",
29       "geometries": [
30         {
31           "type": "LineString",
32           "coordinates": [
33             [
34               -122.4194,
35               37.7749
36             ],
37             [
38               -122.4144,
39               37.7799
40             ]
41           ]
42         }
43       ]
44     },
45     "bbox": [
46       -122.4194,
47       37.7749,
48       -122.4144,
49       37.7799
50     ],
51     "properties": {
52       "address": "1 Market St, San Francisco, CA 94105",
53       "name": "San Francisco Warehouse"
54     },
55     "id": 101
56   },
57   "last_seen_at_timestamp": "2024-01-14T16:45:00Z",
58   "last_seen_at_location_city": "San Francisco",
59   "last_seen_at_location_large_city": "San Francisco Bay Area",
60   "fa_alert_ids": [
61     3456,
62     7890
63   ],
64   "flight_loaded_statuses": [
65     "loaded",
66     "delayed"
67   ],
68   "fa_alert_id_by_flight_number": {
69     "AA1234": 3456,
70     "DL5678": 7890
71   },
72   "flight_status_by_fa_flight_id": {
73     "FA987654321": "in_flight",
74     "FA123456789": "scheduled"
75   },
76   "flight_loaded_status_by_fa_flight_id": {
77     "FA987654321": "loaded",
78     "FA123456789": null
79   }
80 }

Retrieves a single session by its ID. Access restricted to the caller’s organization or shared organizations. | auth: api_key | authz: min_org_role=operator | () -> (Session1)

Authentication

AuthorizationBearer

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

Query parameters

session_idstringRequired

Response

Successful Response

schema_versioninteger

device_idstring

device_mac_addressstring

org_idstring

Must be a string starting with org_

created_at_timestampdatetime

_idstring

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

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

commentsstring<=524288 characters

publicbooleanDefaults to false

off_chrt_shipper_org_idstring

termination_scheduled_for_timestampdatetime

flight_numberslist of strings

fa_flight_idslist of strings

shared_with_org_idslist of strings

terminatedbooleanDefaults to false

terminated_at_timestampdatetime

last_seen_at_locationobject

GeoJSON Feature with typed properties for locations

The geometry field is strongly typed as Geometry (union of all geometry types) but remains optional to match the base Feature class specification. To ensure geometry is always present, validate it at runtime or make it required.

last_seen_at_timestampdatetime

last_seen_at_location_citystring

last_seen_at_location_large_citystring

fa_alert_idslist of integers

flight_loaded_statuseslist of strings

fa_alert_id_by_flight_numbermap from strings to integers

flight_status_by_fa_flight_idmap from strings to enums

flight_loaded_status_by_fa_flight_idmap from strings to optional strings

Errors

422

Sessions Get V1request Unprocessable Entity Error