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   "destination_geofence_entered": true,
10   "destination_geofence_location": {
11     "geometry": {
12       "type": "GeometryCollection",
13       "geometries": [
14         {
15           "type": "LineString",
16           "coordinates": [
17             []
18           ]
19         }
20       ]
21     },
22     "type": "Feature",
23     "bbox": [
24       {
25         "key": "value"
26       }
27     ],
28     "id": 1,
29     "properties": {
30       "address": "address",
31       "name": "name"
32     }
33   },
34   "destination_geofence_radius_miles": 1.1,
35   "flight_leg_ids": [
36     "flight_leg_ids"
37   ],
38   "flight_loaded_status_by_flight_leg_id": {
39     "key": "value"
40   },
41   "flight_loaded_statuses": [
42     "flight_loaded_statuses"
43   ],
44   "flight_numbers": [
45     "flight_numbers"
46   ],
47   "last_seen_at_location": {
48     "geometry": {
49       "type": "GeometryCollection",
50       "geometries": [
51         {
52           "type": "LineString",
53           "coordinates": [
54             []
55           ]
56         }
57       ]
58     },
59     "type": "Feature",
60     "bbox": [
61       {
62         "key": "value"
63       }
64     ],
65     "id": 1,
66     "properties": {
67       "address": "address",
68       "name": "name"
69     }
70   },
71   "last_seen_at_location_city": "last_seen_at_location_city",
72   "last_seen_at_location_large_city": "last_seen_at_location_large_city",
73   "last_seen_at_timestamp": "2024-01-15T09:30:00Z",
74   "off_chrt_reference_id": "off_chrt_reference_id",
75   "off_chrt_shipper_org_id": "off_chrt_shipper_org_id",
76   "public": true,
77   "shared_with_org_ids": [
78     "shared_with_org_ids"
79   ],
80   "terminated": true,
81   "terminated_at_timestamp": "2024-01-15T09:30:00Z",
82   "termination_scheduled_for_timestamp": "2024-01-15T09:30:00Z"
83 }

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

_idstring

created_at_timestampdatetime

device_idstring

device_mac_addressstring

org_idstring

Must be a string starting with org_

schema_versioninteger

commentsstring<=524288 characters

destination_geofence_enteredbooleanDefaults to false

destination_geofence_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.

destination_geofence_radius_milesdouble<=10000Defaults to 0.1

flight_leg_idslist of strings

flight_loaded_status_by_flight_leg_idmap from strings to optional strings

flight_loaded_statuseslist of strings

flight_numberslist of strings

last_seen_at_locationobject

GeoJSON Feature with typed properties for locations

last_seen_at_location_citystring

last_seen_at_location_large_citystring

last_seen_at_timestampdatetime

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).

off_chrt_shipper_org_idstring

publicbooleanDefaults to false

shared_with_org_idslist of strings

terminatedbooleanDefaults to false

terminated_at_timestampdatetime

termination_scheduled_for_timestampdatetime

Errors

422

Sessions Get V1request Unprocessable Entity Error