gatego API documentation

WaireCalculations

GET /api/dashboard/organization/waire/calc

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

date_start string(date-time)

date_start
date_end string(date-time)

date_end
yardId integer(int64)

yardId

Responses

• 200

OK
Hide response attribute Show response attribute object
- yard_waire_stats array[object]
  
  Hide yard_waire_stats attributes Show yard_waire_stats attributes
  
  count object
  
  Hide count attributes Show count attributes
  
  days integer(int64)
  
  end_date string(date-time)
  
  start_date string(date-time)
  
  visits object
  
  Hide visits attribute Show visits attribute
  
  Additional properties: object
  
  Hide Additional properties: attributes Show Additional properties: attributes
  
  class2b_to3_truck_visits integer(int64)
  
  class4_to7_truck_visits integer(int64)
  
  class8_truck_visits integer(int64)
  
  estimated_mitigation_fee string
  
  in_compliance boolean
  
  points_collected string
  
  points_required string
  
  stringency string
  
  weighted_annual_truck_trip string
  
  wpco string
  
  yard_id integer(int64)
• 401

Unauthorized
• 403

Forbidden
• 404

Not Found

GET /api/dashboard/organization/waire/calc

curl \
 -X GET https://api-dev.gatego.io:443/api/dashboard/organization/waire/calc \
 -H "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "yard_waire_stats": [
    {
      "count": {
        "days": 42,
        "end_date": "2023-05-04T09:42:00+00:00",
        "start_date": "2023-05-04T09:42:00+00:00",
        "visits": {}
      },
      "estimated_mitigation_fee": "string",
      "in_compliance": true,
      "points_collected": "string",
      "points_required": "string",
      "stringency": "string",
      "weighted_annual_truck_trip": "string",
      "wpco": "string",
      "yard_id": 42
    }
  ]
}