For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
GithubSign up
DocsCouriersShippersForwardersTrackersAppAPI ReferenceSDKsFAQ
DocsCouriersShippersForwardersTrackersAppAPI ReferenceSDKsFAQ
  • API Reference
          • GETLast seen
          • GETData points
          • POSTMark outliers
          • GETLast seen (public)
          • GETData points (public)
LogoLogo
GithubSign up
API ReferenceTrackingTimeseriesCargo by Device

Data points (public)

GET
/tracking/timeseries/cargo_by_device/data_points_public/v1
GET
/tracking/timeseries/cargo_by_device/data_points_public/v1
1import { ChrtClient } from "@chrt-inc/typescript-sdk";
2
3async function main() {
4 const client = new ChrtClient({
5 token: "YOUR_TOKEN_HERE",
6 });
7 await client.tracking.timeseries.cargoByDevice.dataPointsPublicV1({
8 cargo_id: "cargo_id",
9 task_group_id: "task_group_id",
10 limit: 1,
11 });
12}
13main();
1[
2 {
3 "schema_version": 1,
4 "timestamp": "2024-01-15T09:30:00Z",
5 "metadata": {
6 "task_group_id": "tg-9f8b7c6d",
7 "cargo_id": "cargo-1234abcd",
8 "device_id": "device-5678efgh",
9 "outlier": true,
10 "outlier_labeller": "movingpandas",
11 "paused": true,
12 "pytest": true
13 },
14 "location": {
15 "type": "Feature",
16 "geometry": {
17 "type": "GeometryCollection",
18 "geometries": [
19 {
20 "type": "LineString",
21 "coordinates": [
22 [
23 -122.4194,
24 37.7749
25 ],
26 [
27 -122.418,
28 37.7755
29 ],
30 [
31 -122.417,
32 37.776
33 ]
34 ]
35 }
36 ]
37 },
38 "id": 1
39 },
40 "_id": "dp-0001a2b3c4",
41 "temperature": 1.1
42 }
43]

Returns up to the specified number of data points for a cargo within a public task group, intelligently sampled across the time range. Excludes outliers. No authentication required if cargo has public visibility enabled via sharing settings. | () -> (list[CargoByDeviceDataPoint1])

Was this page helpful?
Previous

Last seen

Next
Built with

Authentication

AuthorizationBearer

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

Query parameters

cargo_idstringRequired
task_group_idstringRequired
limitintegerOptionalDefaults to 100

Response

Successful Response
schema_versioninteger
timestampdatetime
metadataobject
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.

_idstring
temperaturedouble

Errors

422
Cargo by Device Data Points Public V1request Unprocessable Entity Error