Skip to navigation
IntelligenceAnalytics

Get partner dashboard overview

Retrieve an aggregate KPI summary for the partner dashboard’s home overview page: fleet/vehicle/driver/trailer counts, location coverage, rolling 30-day safety and HOS violation counts, and invitation/webhook totals, in a single call. invitations and webhooks are partner-wide and not affected by fleet filtering.

Authentication

AuthorizationBearer

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

Query parameters

fleet_idslist of strings or nullOptional

Limit results to specific fleets using Catena’s fleet IDs. For your own fleet identifiers, use fleet_refs instead To specify multiple values, repeat the parameter for each value (e.g., ?fleet_ids=id1&fleet_ids=id2).

fleet_refslist of strings or nullOptional

Limit results to specific fleets using your organization’s fleet reference identifiers. To specify multiple values, repeat the parameter for each value (e.g., ?fleet_refs=ref1&fleet_refs=ref2).

connection_idstring or nullOptionalformat: "uuid"
Limit results to a specific provider connection. This is the UUID assigned by Catena when your fleet connects to a TSP.

Response

Successful Response
fleetsinteger
Current count of active fleets.
vehiclesinteger
Current count of active vehicles.
driversinteger
Current count of active drivers.
trailersinteger
Current count of active trailers.
vehicles_with_locationsinteger

Number of vehicles that have reported at least one location update (indicates active telematics).

trailers_with_locationsinteger

Number of trailers that have reported at least one location update (indicates active telematics).

safety_events_30dinteger
Count of safety events recorded across the partner's fleets in the last 30 days.
hos_violations_30dinteger
Count of HOS violations recorded across the partner's fleets in the last 30 days.
latest_updatedatetime or null

Most recent occurred_at timestamp (UTC) across vehicle locations, trailer locations, and HOS event logs. Null if there is no telemetry yet.

invitationsinteger

Total number of non-deleted fleet invitations sent by this partner, across all statuses.

webhooksinteger

Total number of non-deleted webhook subscriptions configured by this partner.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
405
Method Not Allowed Error
409
Conflict Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error
501
Not Implemented Error