Endpoint for Retrieving a Yard Summary

GET /api/yard-task/summary/{yardId}

Path parameters

yardId integer(int64) Required

Yard ID

Responses

default application/json

Summary retrieved successfully
Hide response attributes Show response attributes object
- total_tasks integer(int32)
  
  Total tasks
- total_tasks_completed integer(int32)
  
  Total tasks completed
- total_tasks_in_progress integer(int32)
  
  Total tasks in progress
- total_tasks_in_queue integer(int32)
  
  Total tasks in queue
- average_time integer(int32)
  
  Average time
- top_speed integer(int32)
  
  Top speed
- active_drivers integer(int32)
  
  Active Drivers
- yard_details array[object]
  
  Break down of data above
  
  Yard Detail
  
  Hide yard_details attributes Show yard_details attributes object
  
  yard_id integer(int64)
  
  Yard Id
  
  total_tasks integer(int32)
  
  Yard tasks
  
  tasks_completed integer(int32)
  
  Yard tasks completed
  
  tasks_in_progress integer(int32)
  
  Yard tasks in progress
  
  tasks_in_queue integer(int32)
  
  Yard tasks in queue
  
  average_time integer(int32)
  
  Yard average time
  
  top_speed integer(int32)
  
  Yard top speed
  
  active_drivers integer(int32)
  
  Active Drivers
401

Not Authorized
403

Not Allowed

GET /api/yard-task/summary/{yardId}

curl \
 --request GET 'https://api-dev.gatego.io/api/yard-task/summary/{yardId}'

Response examples (default)

{
  "total_tasks": 1,
  "total_tasks_completed": 1,
  "total_tasks_in_progress": 1,
  "total_tasks_in_queue": 1,
  "average_time": 1,
  "top_speed": 10,
  "active_drivers": 1,
  "yard_details": [
    {
      "yard_id": 1,
      "total_tasks": 5,
      "tasks_completed": 3,
      "tasks_in_progress": 1,
      "tasks_in_queue": 1,
      "average_time": 2,
      "top_speed": 12,
      "active_drivers": 1
    }
  ]
}