Skip to main content
GET
/
v2
/
integrations
/
connections
/
data-freshness
Get Data Freshness
curl --request GET \
  --url https://api.catenatelematics.com/v2/integrations/connections/data-freshness \
  --header 'Authorization: Bearer <token>'
[
  {
    "connection_description": "My fleet ELD connection",
    "connection_id": "123e4567-e89b-12d3-a456-426614174000",
    "fleet_id": "123e4567-e89b-12d3-a456-426614173999",
    "fleet_ref": "my-fleet-ref",
    "last_successful_execution_at": "2024-01-01T12:00:00Z",
    "next_execution_at": "2024-01-01T13:00:00Z",
    "resource": "vehicle",
    "schedule_id": "123e4567-e89b-12d3-a456-426614174002",
    "schedule_status": "active",
    "share_level": "read_write",
    "source_name": "geotab",
    "tsp_id": "123e4567-e89b-12d3-a456-426614174001",
    "tsp_slug": "geotab"
  }
]

Documentation Index

Fetch the complete documentation index at: https://docs.catenatelematics.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
fleet_ids
string<uuid>[] | null

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).

Maximum array length: 100
​
fleet_refs
string[] | null

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).

Maximum array length: 100

Response

Successful Response

​
resource
enum<string>
required

The telematics resource type this entry describes.

Available options:
asset,
driver_association,
driver_vehicle_association,
driver_event_log,
driver_safety_event,
dvir_log,
dvir_log_defect,
engine_log,
engine_status,
fuel_transaction,
hos_availability,
hos_daily_snapshot,
hos_event,
hos_event_annotation,
hos_event_attachment,
hos_violation,
ifta_summary,
location_segment,
message,
user,
vehicle,
vehicle_location,
vehicle_sensor,
vehicle_region_segment,
trailer,
trailer_association,
trailer_vehicle_association,
trailer_location,
trailer_status,
workflow
​
fleet_id
string<uuid>
required

Unique identifier of the fleet this freshness record applies to.

​
connection_id
string<uuid>
required

Unique identifier of the telematics provider connection that supplies this resource's data.

​
schedule_id
string<uuid>
required

Unique identifier of the schedule that controls automatic data fetching for this resource.

​
source_name
string
required

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

​
tsp_id
string<uuid>
required

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

​
tsp_slug
string
required

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

​
last_successful_execution_at
string<date-time> | null
required

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_at
string<date-time> | null
required

Timestamp of the next automatic data fetch.

​
schedule_status
enum<string> | null
required

Enum representing the possible statuses of a schedule.

Available options:
inactive,
active,
paused,
stale,
deleted,
cancelled,
cancelled_insufficient_scope
​
share_level
enum<string> | null

Enum for the level of access granted

Available options:
read,
read_write
​
fleet_ref
string | null

Partner's reference for the fleet in their system.

​
connection_description
string | null

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