Retrieve (via POST) driver analytics

POST

/shipping/drivers/stats/v1/:driver_id

POST

/shipping/drivers/stats/v1/:driver_id

import { ChrtClient } from "@chrt-inc/typescript-sdk";
async function main() {
    const client = new ChrtClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.shipping.drivers.getStatsV1("driver_id", {
        end_timestamp: "2024-01-15T09:30:00Z",
        start_timestamp: "2024-01-15T09:30:00Z",
    });
}
main();

{
  "driver_analytics_days": [
    {
      "day": "day",
      "observed_mileage_order_in_progress_deduped": 1.1,
      "observed_mileage_order_not_in_progress": 1.1,
      "observed_mileage_total": 1.1,
      "self_reported_hours_and_mileage": {
        "_id": "_id",
        "created_at_timestamp": "2024-01-15T09:30:00Z",
        "created_by_user_id": "created_by_user_id",
        "date": "date",
        "driver_id": "driver_id",
        "org_id": "org_id",
        "schema_version": 1,
        "updated_at": "2024-01-15T09:30:00Z"
      }
    }
  ],
  "driver_analytics_task_groups": [
    {
      "observed_mileage_order_in_progress": 1.1,
      "task_group": {
        "_id": "_id",
        "created_by_org_id": "created_by_org_id",
        "draft_started_at_timestamp": "2024-01-15T09:30:00Z",
        "order_id": "order_id",
        "order_short_id": "order_short_id",
        "schema_version": 1,
        "task_group_type": "chrt_ground_provider"
      }
    }
  ]
}

Retrieves driver analytics for a time window. Daily rows are clipped to the requested UTC window; task-group rows include full in-progress mileage for task groups whose in-progress interval overlaps the requested window. | 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

Response

Successful Response

driver_analytics_dayslist of objectsOptional

driver_analytics_task_groupslist of objectsOptional

Errors

422

Drivers Get Stats V1request Unprocessable Entity Error