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         start_timestamp: "2024-01-01T08:00:00Z",
9         end_timestamp: "2024-01-15T18:00:00Z",
10     });
11 }
12 main();

1 {
2   "task_groups": [
3     {
4       "schema_version": 1,
5       "_id": "tg_9876543210abcdef",
6       "order_id": "ord_1234567890abcdef",
7       "order_short_id": "ORD12345",
8       "created_by_org_id": "org_provider_001",
9       "draft_started_at_timestamp": "2024-01-10T07:00:00Z",
10       "task_group_type": "chrt_ground_provider",
11       "order_off_chrt_reference_id": "ref_ABC123_XYZ",
12       "task_ids": [
13         "task_001",
14         "task_002",
15         "task_003"
16       ],
17       "order_schedule_id": "sched_20240115",
18       "order_schedule_run_idempotency_key": "runkey_20240115_001",
19       "order_schedule_template_path": "/templates/schedule_2024_01.json",
20       "created_by_user_id": "user_jdoe123",
21       "shipper_org_id": "org_shipper_007",
22       "off_chrt_shipper_org_id": "offchrt_shipper_007",
23       "coordinator_org_id": "org_coordinator_003",
24       "executor_org_id": "org_executor_005",
25       "off_chrt_executor_org_id": "offchrt_executor_005",
26       "driver_id": "driver_456789",
27       "task_group_s3_object_metadata_ids": [
28         "s3meta_abc123",
29         "s3meta_def456"
30       ],
31       "status": "completed",
32       "order_cancelled": false,
33       "staged_at_timestamp": "2024-01-11T08:00:00Z",
34       "in_progress_at_timestamp": "2024-01-12T09:00:00Z",
35       "completed_at_timestamp": "2024-01-14T17:30:00Z",
36       "skipped_at_timestamp": "2024-01-13T12:00:00Z",
37       "exception_at_timestamp": "2024-01-13T15:00:00Z",
38       "vehicle_type": "cargo_van",
39       "mileage_estimated": 120.5,
40       "mileage_observed": 118.7,
41       "wait_time_total_minutes": 45,
42       "mileage_asserted": true,
43       "flight_number": "AA1234",
44       "fa_flight_ids": [
45         "fa_20240115_001",
46         "fa_20240115_002"
47       ],
48       "messages": [
49         {
50           "message": "Driver reported minor delay due to traffic.",
51           "user_id": "user_dispatcher01",
52           "org_id": "org_provider_001",
53           "timestamp": "2024-01-12T10:15:00Z"
54         },
55         {
56           "message": "Task group completed successfully.",
57           "user_id": "user_supervisor02",
58           "org_id": "org_provider_001",
59           "timestamp": "2024-01-14T18:00:00Z"
60         }
61       ],
62       "shipper_pay_provider_rate_sheet_id": "rate_sheet_2024Q1",
63       "shipper_pay_provider_line_item_group_id": "line_item_group_001",
64       "shipper_pay_provider_billing_ledger_period_id": "billing_period_202401",
65       "provider_pay_provider_rate_sheet_id": "provider_rate_sheet_2024Q1",
66       "provider_pay_provider_line_item_group_id": "provider_line_item_group_001",
67       "provider_pay_provider_billing_ledger_period_id": "provider_billing_period_202401",
68       "provider_pay_driver_rate_sheet_id": "driver_rate_sheet_2024Q1",
69       "provider_pay_driver_line_item_group_id": "driver_line_item_group_001",
70       "provider_pay_driver_billing_ledger_period_id": "driver_billing_period_202401"
71     }
72   ],
73   "excluded_task_groups": [
74     {
75       "schema_version": 1,
76       "_id": "tg_excluded_1234567890",
77       "order_id": "ord_excluded_0987654321",
78       "order_short_id": "ORD54321",
79       "created_by_org_id": "org_provider_002",
80       "draft_started_at_timestamp": "2024-01-05T06:00:00Z",
81       "task_group_type": "cargo_on_flight",
82       "order_off_chrt_reference_id": "ref_EXCL_456DEF",
83       "task_ids": [
84         "task_010",
85         "task_011"
86       ],
87       "order_schedule_id": "sched_20240110",
88       "order_schedule_run_idempotency_key": "runkey_20240110_002",
89       "order_schedule_template_path": "/templates/schedule_2024_01_excluded.json",
90       "created_by_user_id": "user_jane_doe",
91       "shipper_org_id": "org_shipper_008",
92       "off_chrt_shipper_org_id": "offchrt_shipper_008",
93       "coordinator_org_id": "org_coordinator_004",
94       "executor_org_id": "org_executor_006",
95       "off_chrt_executor_org_id": "offchrt_executor_006",
96       "driver_id": "driver_987654",
97       "task_group_s3_object_metadata_ids": [
98         "s3meta_xyz789"
99       ],
100       "status": "skipped",
101       "order_cancelled": true,
102       "staged_at_timestamp": "2024-01-06T07:00:00Z",
103       "in_progress_at_timestamp": "2024-01-07T08:00:00Z",
104       "completed_at_timestamp": "2024-01-08T17:00:00Z",
105       "skipped_at_timestamp": "2024-01-07T12:00:00Z",
106       "exception_at_timestamp": "2024-01-07T13:00:00Z",
107       "vehicle_type": "semi_truck",
108       "mileage_estimated": 300,
109       "mileage_observed": 295.5,
110       "wait_time_total_minutes": 30,
111       "mileage_asserted": false,
112       "flight_number": "DL5678",
113       "fa_flight_ids": [
114         "fa_20240110_010"
115       ],
116       "messages": [
117         {
118           "message": "Task group excluded due to weather conditions.",
119           "user_id": "user_manager01",
120           "org_id": "org_provider_002",
121           "timestamp": "2024-01-07T11:00:00Z"
122         }
123       ],
124       "shipper_pay_provider_rate_sheet_id": "rate_sheet_2024Q1_excl",
125       "shipper_pay_provider_line_item_group_id": "line_item_group_002",
126       "shipper_pay_provider_billing_ledger_period_id": "billing_period_202401_excl",
127       "provider_pay_provider_rate_sheet_id": "provider_rate_sheet_2024Q1_excl",
128       "provider_pay_provider_line_item_group_id": "provider_line_item_group_002",
129       "provider_pay_provider_billing_ledger_period_id": "provider_billing_period_202401_excl",
130       "provider_pay_driver_rate_sheet_id": "driver_rate_sheet_2024Q1_excl",
131       "provider_pay_driver_line_item_group_id": "driver_line_item_group_002",
132       "provider_pay_driver_billing_ledger_period_id": "driver_billing_period_202401_excl"
133     }
134   ],
135   "cleaned_task_group_duration_hours": 38.5,
136   "overlap_detected": true,
137   "total_mileage_observed": 414.2
138 }

Retrieves driver stats (hours worked + observed mileage) with overlap-corrected duration. | 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.

start_timestampdatetimeRequired

end_timestampdatetimeRequired

excluded_task_group_idslist of stringsOptional

Response

Successful Response

task_groupslist of objects

excluded_task_groupslist of objects

cleaned_task_group_duration_hoursdouble

overlap_detectedboolean

total_mileage_observeddouble

Errors

422

Drivers Get Stats V1request Unprocessable Entity Error