Skip to navigation
IntegrationsConnections

Get Data Freshness

Get a summary of data freshness for a fleet's telematics connections.

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. Maximum: 100 IDs. 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 fleet references. Maximum: 100 references. To specify multiple values, repeat the parameter for each value (e.g., ?fleet_refs=ref1&fleet_refs=ref2).

Response

Successful Response
resourceenum
The telematics resource type this entry describes.
fleet_idstringformat: "uuid"
Unique identifier of the fleet this freshness record applies to.
connection_idstringformat: "uuid"
Unique identifier of the telematics provider connection that supplies this resource's data.
schedule_idstringformat: "uuid"
Unique identifier of the schedule that controls automatic data fetching for this resource.
source_namestring

Name of the telematics provider (e.g., geotab, samsara, motive).

tsp_idstringformat: "uuid"

Unique identifier of the telematics service provider (TSP) at Catena.

tsp_slugstring

Human-readable identifier of the telematics service provider (TSP) at Catena.

last_successful_execution_atdatetime or null

Timestamp of the most recent successful data fetch from the telematics provider for this resource. This is the primary data-freshness indicator. Null means no data has been fetched yet.

next_execution_atdatetime or null
Timestamp of the next automatic data fetch.
schedule_statusenum or null

Current state of the automatic data-fetch schedule.

share_levelenum or nullOptional
The permission level granted by the fleet for this resource.
Allowed values:
fleet_refstring or nullOptional
Partner's reference for the fleet in their system.
connection_descriptionstring or nullOptional

Optional user-provided description of the connection. Useful when the fleet has multiple accounts with the same TSP.

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
504
Gateway Timeout Error