Skip to main content
GET
Get vehicle utilization benchmarks

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

vehicle_id
string<uuid>
required

Query Parameters

from_date
string<date> | null

Inclusive start of the benchmark window. Format: YYYY-MM-DD Default: 30 days before yesterday (trailing-30d hot window). Restriction: to_date - from_date cannot exceed 90 days.

Example:

null

to_date
string<date> | null

Inclusive end of the benchmark window. Format: YYYY-MM-DD Default: yesterday (most recent completed day in the utilization pipeline). Restriction: to_date - from_date cannot exceed 90 days.

Example:

null

Response

Successful Response

vehicle_id
string<uuid>
required

Catena vehicle identifier.

cohort_id
string<uuid>
required

Cohort the vehicle was benchmarked against.

window
BenchmarkWindow · object
required

Date range used for the benchmark.

vehicle_value
integer | null
required

Vehicle's average meters/day over the window. Null if the vehicle has no utilization data.

percentile
integer | null
required

Vehicle's percentile rank (0-100) within the cohort daily distribution. Null if suppressed by k-anonymity or data unavailable.

cohort
CohortStats · object | null
required

Cohort size metrics. Null if suppressed by k-anonymity or data unavailable.

cached
boolean
required

True when the response was served from the pre-computed percentile cache; False when computed live from daily sketches.

metric
string
default:meters_driven

Metric being benchmarked (v1: always 'meters_driven').

Allowed value: "meters_driven"