gatego API documentation

YardActivity

GET /api/dashboard/summary/yard-activity

Headers

X-Gatego-oid

Specify effective organization_id for Admin and Group Organization Admins. This is a global header for all endpoints only taken into consideration when it makes sense (it won't be used in Auth, for example)

Query parameters

yard_id integer(int64)

yard_id
show_other_carriers boolean

show_other_carriers
carrier_id integer(int64)

carrier_id

Responses

• 200

OK
Hide response attributes Show response attributes object
- carriers array[object]
  
  Hide carriers attributes Show carriers attributes
  
  carrier_id integer(int64)
  
  carrier_name string
  
  total integer(int32)
  
  usage integer(int32)
- total integer(int32)
- usage integer(int32)
• 401

Unauthorized
• 403

Forbidden
• 404

Not Found

GET /api/dashboard/summary/yard-activity

curl \
 -X GET https://api-dev.gatego.io:443/api/dashboard/summary/yard-activity \
 -H "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "carriers": [
    {
      "carrier_id": 42,
      "carrier_name": "string",
      "total": 42,
      "usage": 42
    }
  ],
  "total": 42,
  "usage": 42
}