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   "_id": "_id",
3   "created_at_timestamp": "2024-01-15T09:30:00Z",
4   "device_id": "device_id",
5   "device_mac_address": "device_mac_address",
6   "org_id": "org_id",
7   "schema_version": 1,
8   "comments": "comments",
9   "flight_leg_ids": [
10     "flight_leg_ids"
11   ],
12   "flight_loaded_status_by_flight_leg_id": {
13     "key": "value"
14   },
15   "flight_loaded_statuses": [
16     "flight_loaded_statuses"
17   ],
18   "flight_numbers": [
19     "flight_numbers"
20   ],
21   "geofences": [
22     {
23       "display_name": "display_name",
24       "geofence_id": "geofence_id",
25       "location": {
26         "geometry": {
27           "coordinates": [],
28           "type": "Point"
29         },
30         "type": "Feature"
31       },
32       "radius_miles": 1.1,
33       "entered": true,
34       "entered_at_timestamp": "2024-01-15T09:30:00Z"
35     }
36   ],
37   "last_seen_at_location": {
38     "geometry": {
39       "type": "GeometryCollection",
40       "geometries": [
41         {
42           "type": "LineString",
43           "coordinates": [
44             []
45           ]
46         }
47       ]
48     },
49     "type": "Feature",
50     "bbox": [
51       {
52         "key": "value"
53       }
54     ],
55     "id": 1,
56     "properties": {
57       "address": "address",
58       "name": "name"
59     }
60   },
61   "last_seen_at_location_city": "last_seen_at_location_city",
62   "last_seen_at_location_large_city": "last_seen_at_location_large_city",
63   "last_seen_at_timestamp": "2024-01-15T09:30:00Z",
64   "off_chrt_reference_id": "off_chrt_reference_id",
65   "off_chrt_shipper_org_data_id": "off_chrt_shipper_org_data_id",
66   "public": true,
67   "shared_with_org_ids": [
68     "shared_with_org_ids"
69   ],
70   "terminated": true,
71   "terminated_at_timestamp": "2024-01-15T09:30:00Z",
72   "termination_scheduled_for_timestamp": "2024-01-15T09:30:00Z"
73 }

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 | () -> (Session2)

Authentication

AuthorizationBearer

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

Query parameters

session_idstringRequired

Response

Successful Response

_idstring

created_at_timestampdatetime

device_idstring

device_mac_addressstring

org_idstring

Must be a string starting with org_

schema_versioninteger

commentsstring or nullOptional<=524288 characters

flight_leg_idslist of stringsOptional

flight_loaded_status_by_flight_leg_idmap from strings to nullable or optional stringsOptional

flight_loaded_statuseslist of stringsOptional

flight_numberslist of stringsOptional

geofenceslist of objectsOptional

last_seen_at_locationobject or nullOptional

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_location_citystring or nullOptional

last_seen_at_location_large_citystring or nullOptional

last_seen_at_timestampdatetime or nullOptional

off_chrt_reference_idstring or nullOptionalformat: "^[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).

off_chrt_shipper_org_data_idstring or nullOptional

publicbooleanOptionalDefaults to false

shared_with_org_idslist of stringsOptional

terminatedbooleanOptionalDefaults to false

terminated_at_timestampdatetime or nullOptional

termination_scheduled_for_timestampdatetime or nullOptional

Errors

422

Sessions Get V1request Unprocessable Entity Error