curl --request GET \
--url https://api.tread-horizon.com/v1/jobs/{job-id}/summary \
--header 'Authorization: Bearer <token>'{
"data": {
"has_gps_data": true,
"logging_started_at": "2023-11-07T05:31:56Z",
"logging_ended_at": "2023-11-07T05:31:56Z",
"completed_loads_count": 1,
"break_time_minutes": 1,
"work_time_minutes": 1,
"approved_work_time_minutes": 123,
"first_geofence_entry_at": "2023-11-07T05:31:56Z",
"last_geofence_exit_at": "2023-11-07T05:31:56Z",
"job_phase_name": "<string>",
"job_phase_code": "<string>",
"foreman_external_id": "<string>",
"delivered_quantities": [
{
"delivered": "<string>",
"unit_of_measure": "Load",
"material_name": "<string>",
"total": "<string>",
"ticketed": true
}
],
"adjusted_logging_started_at": "2023-11-07T05:31:56Z",
"adjusted_logging_ended_at": "2023-11-07T05:31:56Z",
"editable": true,
"loads_with_tickets_count": 123,
"pre_clamp_logging_ended_at": "2023-11-07T05:31:56Z",
"travelled_distance_meters": "<string>",
"first_sent_at": "2023-11-07T05:31:56Z",
"sent_to_driver_at": "2023-11-07T05:31:56Z",
"driver_accepted_at": "2023-11-07T05:31:56Z",
"driver_declined_at": "2023-11-07T05:31:56Z",
"first_accepted_at": "2023-11-07T05:31:56Z",
"first_declined_at": "2023-11-07T05:31:56Z",
"first_canceled_at": "2023-11-07T05:31:56Z",
"pickup_geofence_entry_count": 1,
"dropoff_geofence_entry_count": 1,
"gps_active_period_minutes": 1,
"gps_total_pings": 1,
"gps_offline_pings": 1,
"gps_expected_pings": 1,
"gps_confidence_level": "high"
}
}Retrieve the JobSummary for a Job.
A JobSummary will only exist for a Job in the completed state.
curl --request GET \
--url https://api.tread-horizon.com/v1/jobs/{job-id}/summary \
--header 'Authorization: Bearer <token>'{
"data": {
"has_gps_data": true,
"logging_started_at": "2023-11-07T05:31:56Z",
"logging_ended_at": "2023-11-07T05:31:56Z",
"completed_loads_count": 1,
"break_time_minutes": 1,
"work_time_minutes": 1,
"approved_work_time_minutes": 123,
"first_geofence_entry_at": "2023-11-07T05:31:56Z",
"last_geofence_exit_at": "2023-11-07T05:31:56Z",
"job_phase_name": "<string>",
"job_phase_code": "<string>",
"foreman_external_id": "<string>",
"delivered_quantities": [
{
"delivered": "<string>",
"unit_of_measure": "Load",
"material_name": "<string>",
"total": "<string>",
"ticketed": true
}
],
"adjusted_logging_started_at": "2023-11-07T05:31:56Z",
"adjusted_logging_ended_at": "2023-11-07T05:31:56Z",
"editable": true,
"loads_with_tickets_count": 123,
"pre_clamp_logging_ended_at": "2023-11-07T05:31:56Z",
"travelled_distance_meters": "<string>",
"first_sent_at": "2023-11-07T05:31:56Z",
"sent_to_driver_at": "2023-11-07T05:31:56Z",
"driver_accepted_at": "2023-11-07T05:31:56Z",
"driver_declined_at": "2023-11-07T05:31:56Z",
"first_accepted_at": "2023-11-07T05:31:56Z",
"first_declined_at": "2023-11-07T05:31:56Z",
"first_canceled_at": "2023-11-07T05:31:56Z",
"pickup_geofence_entry_count": 1,
"dropoff_geofence_entry_count": 1,
"gps_active_period_minutes": 1,
"gps_total_pings": 1,
"gps_offline_pings": 1,
"gps_expected_pings": 1,
"gps_confidence_level": "high"
}
}Documentation Index
Fetch the complete documentation index at: https://docs.tread.ai/llms.txt
Use this file to discover all available pages before exploring further.
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
The Accept-Language request HTTP header indicates the natural language and locale that the client prefers.
"en"
Job ID
OK
Show child attributes