Skip to main content

Driver Performance

2 API calls in this section.

Get Driver Performance

Delivery & Last-Mile / Driver Performance
GET/delivery/driver-performance?driver_id=&period_start=&period_end=&period_type=daily&tenant_id=&language=en

Retrieves performance metrics for drivers. Returns historical metrics from the database if available, otherwise calculates metrics on demand from delivery and exception data. Requires view:tenant or manage:operations:tenant permission.

Send a bearer token in the Authorization header for an authenticated OnDi user session.
Request
curl
1curl --request GET "$ONDI_BASE_URL/delivery/driver-performance?driver_id=&period_start=&period_end=&period_type=daily&tenant_id=&language=en" \2  --header "Authorization: Bearer {{access_token}}"

Query parameters

driver_idOptional
query string

Optional ID of a specific driver to get performance for. If not provided, returns metrics for all drivers.

period_startOptional
query string

Start date for the period (ISO format). Defaults to 30 days ago for daily, 90 days for weekly, 12 months for monthly.

period_endOptional
query string

End date for the period (ISO format). Defaults to current date.

period_typeOptional
query string

daily

Type of period for metrics aggregation: daily, weekly, or monthly.

tenant_idOptional
query string

Tenant ID (optional if in auth token)

languageOptional
query string

en

Preferred language for response messages

Headers

AuthorizationOptional
header string

Bearer {{access_token}}

Responses

Success Response - Stored Metrics200OK
Success Response - Calculated Metrics200OK
Error - Invalid Period Type400Bad Request
Error - Invalid Date Format400Bad Request
Error - Insufficient Permissions403Forbidden

Get Driver Performance Detail

Delivery & Last-Mile / Driver Performance
GET/delivery/driver-performance/detail?driver_id=uuid&tenant_id=&language=en

Get detailed performance for a single driver including current month, previous month comparison, and 6-month history for charts.

Send a bearer token in the Authorization header for an authenticated OnDi user session.
Request
curl
1curl --request GET "$ONDI_BASE_URL/delivery/driver-performance/detail?driver_id=uuid&tenant_id=&language=en" \2  --header "Authorization: Bearer {{access_token}}"

Query parameters

driver_idOptional
query string

uuid

Required. Driver ID to get detail for.

tenant_idOptional
query string

Tenant ID

languageOptional
query string

en

Response language

Headers

AuthorizationOptional
header string

Bearer {{access_token}}

Responses

Success - Driver detail with history200OK
Error - driver_id required400Bad Request