Retrieve (via POST) driver stats

POST

/shipping/drivers/stats/v1/:driver_id

POST

/shipping/drivers/stats/v1/:driver_id

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.shipping.drivers.getStatsV1("driver_id", {
8         end_timestamp: "2024-01-15T17:30:00Z",
9         start_timestamp: "2024-01-15T08:00:00Z",
10     });
11 }
12 main();

1 {
2   "deduped_task_group_driver_hours": 7.5,
3   "excluded_task_groups": [
4     {
5       "_id": "tg_9f8e7d6c5b4a3",
6       "created_by_org_id": "org_67890creator",
7       "draft_started_at_timestamp": "2024-01-14T22:00:00Z",
8       "order_id": "order_7890",
9       "order_short_id": "ORD7890",
10       "schema_version": 1,
11       "task_group_type": "chrt_ground_provider",
12       "cancelled_at_timestamp": "2024-01-15T12:00:00Z",
13       "completed_at_timestamp": "2024-01-15T11:45:00Z",
14       "coordinator_org_id": "org_12345coordinator",
15       "created_by_user_id": "user_abc123creator",
16       "driver_id": "driver_00123",
17       "exception_at_timestamp": "2024-01-15T10:30:00Z",
18       "executor_org_id": "org_54321executor",
19       "flight_leg_ids": [
20         "fl_leg_001",
21         "fl_leg_002"
22       ],
23       "flight_setup_notes": "Delayed due to weather conditions",
24       "in_progress_at_timestamp": "2024-01-15T09:00:00Z",
25       "messages": [
26         {
27           "message": "Driver reported mechanical issue, resolved on site.",
28           "org_id": "org_67890creator",
29           "timestamp": "2024-01-15T10:15:00Z",
30           "user_id": "user_abc123creator"
31         }
32       ],
33       "mileage_asserted": true,
34       "mileage_estimated": 45.7,
35       "mileage_observed": 44.9,
36       "off_chrt_executor_org_id": "off_org_001",
37       "off_chrt_shipper_org_id": "off_org_002",
38       "order_off_chrt_reference_id": "ref_ORD12345",
39       "order_schedule_template_path_idempotency_key": "sched_key_20240115",
40       "provider_pay_driver_billing_ledger_period_id": "ledger_202401",
41       "provider_pay_driver_line_item_group_id": "lineitem_001",
42       "provider_pay_driver_rate_sheet_id": "rate_2024Q1",
43       "provider_pay_provider_billing_ledger_period_id": "ledger_prov_202401",
44       "provider_pay_provider_line_item_group_id": "lineitem_prov_001",
45       "provider_pay_provider_rate_sheet_id": "rate_prov_2024Q1",
46       "shipper_org_id": "org_shipper_123",
47       "shipper_pay_provider_billing_ledger_period_id": "shipper_ledger_202401",
48       "shipper_pay_provider_line_item_group_id": "shipper_lineitem_001",
49       "shipper_pay_provider_rate_sheet_id": "shipper_rate_2024Q1",
50       "skipped_at_timestamp": "2024-01-15T08:30:00Z",
51       "staged_at_timestamp": "2024-01-15T08:45:00Z",
52       "status": "cancelled",
53       "task_group_s3_object_metadata_ids": [
54         "s3_meta_001",
55         "s3_meta_002"
56       ],
57       "task_ids": [
58         "task_001",
59         "task_002"
60       ],
61       "vehicle_type": "cargo_van",
62       "wait_time_total_minutes": 15
63     }
64   ],
65   "overlapping_task_groups_detected": true,
66   "task_groups": [
67     {
68       "_id": "tg_123abc456def",
69       "created_by_org_id": "org_67890creator",
70       "draft_started_at_timestamp": "2024-01-14T20:00:00Z",
71       "order_id": "order_4567",
72       "order_short_id": "ORD4567",
73       "schema_version": 1,
74       "task_group_type": "cargo_on_flight",
75       "cancelled_at_timestamp": "2024-01-15T16:00:00Z",
76       "completed_at_timestamp": "2024-01-15T15:45:00Z",
77       "coordinator_org_id": "org_12345coordinator",
78       "created_by_user_id": "user_abc123creator",
79       "driver_id": "driver_00123",
80       "exception_at_timestamp": "2024-01-15T14:30:00Z",
81       "executor_org_id": "org_54321executor",
82       "flight_leg_ids": [
83         "fl_leg_003",
84         "fl_leg_004"
85       ],
86       "flight_setup_notes": "Smooth loading and unloading",
87       "in_progress_at_timestamp": "2024-01-15T09:30:00Z",
88       "messages": [
89         {
90           "message": "All tasks completed without incident.",
91           "org_id": "org_67890creator",
92           "timestamp": "2024-01-15T15:00:00Z",
93           "user_id": "user_abc123creator"
94         }
95       ],
96       "mileage_asserted": true,
97       "mileage_estimated": 75.3,
98       "mileage_observed": 74.8,
99       "off_chrt_executor_org_id": "off_org_003",
100       "off_chrt_shipper_org_id": "off_org_004",
101       "order_off_chrt_reference_id": "ref_ORD67890",
102       "order_schedule_template_path_idempotency_key": "sched_key_20240114",
103       "provider_pay_driver_billing_ledger_period_id": "ledger_202401",
104       "provider_pay_driver_line_item_group_id": "lineitem_002",
105       "provider_pay_driver_rate_sheet_id": "rate_2024Q1",
106       "provider_pay_provider_billing_ledger_period_id": "ledger_prov_202401",
107       "provider_pay_provider_line_item_group_id": "lineitem_prov_002",
108       "provider_pay_provider_rate_sheet_id": "rate_prov_2024Q1",
109       "shipper_org_id": "org_shipper_456",
110       "shipper_pay_provider_billing_ledger_period_id": "shipper_ledger_202401",
111       "shipper_pay_provider_line_item_group_id": "shipper_lineitem_002",
112       "shipper_pay_provider_rate_sheet_id": "shipper_rate_2024Q1",
113       "skipped_at_timestamp": "2024-01-15T08:15:00Z",
114       "staged_at_timestamp": "2024-01-15T08:30:00Z",
115       "status": "completed",
116       "task_group_s3_object_metadata_ids": [
117         "s3_meta_003",
118         "s3_meta_004"
119       ],
120       "task_ids": [
121         "task_003",
122         "task_004"
123       ],
124       "vehicle_type": "box_truck",
125       "wait_time_total_minutes": 10
126     }
127   ],
128   "deduped_task_group_driver_mileage_tracked": 120.4,
129   "self_reported_hours_and_mileage": [
130     {
131       "_id": "sr_00123",
132       "created_at_timestamp": "2024-01-15T18:00:00Z",
133       "created_by_user_id": "user_abc123creator",
134       "date": "2024-01-15",
135       "driver_id": "driver_00123",
136       "org_id": "org_67890creator",
137       "schema_version": 1,
138       "updated_at": "2024-01-15T18:30:00Z",
139       "hours_worked": 8,
140       "miles_driven": 130.5
141     }
142   ],
143   "total_driver_mileage_tracked": 135.2
144 }

Retrieves driver stats for a time window: overlap-corrected hours worked, total GPS mileage, and mileage restricted to worked task-group intervals. | authz: allowed_org_types=[provider], min_org_role=operator | (DriverStatsReq) -> (DriverStatsRes)

Authentication

AuthorizationBearer

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

Path parameters

driver_idstringRequired

Request

This endpoint expects an object.

end_timestampdatetimeRequired

start_timestampdatetimeRequired

excluded_task_group_idslist of stringsOptional

Response

Successful Response

deduped_task_group_driver_hoursdouble

Summed from task group in-progress intervals merged to eliminate double-counting of overlapping task groups.

excluded_task_groupslist of objects

overlapping_task_groups_detectedboolean

task_groupslist of objects

deduped_task_group_driver_mileage_trackeddouble

Total mileage from pings that fall within task group in-progress merged intervals. i.e. excludes pings outside of merged task group time windows

self_reported_hours_and_mileagelist of objects

total_driver_mileage_trackeddouble

Total mileage recorded for this driver across all tracked pings that fall within the requested query window. Independent of task group filtering or deduplication. i.e. includes pings inside and outside of task group time windows

Errors

422

Drivers Get Stats V1request Unprocessable Entity Error