API changelog
Download source
  • JSON OpenAPI specification
  • YAML OpenAPI specification
Garmat API logo

Topics

  • Introduction
  • Authentication
  • Getting Started
  • Glossary
  • Rate Limiting
  • Troubleshooting

Endpoints

  • Accounts
    • Summary of accounts and booths GET
    • Get an account GET
    • Update an existing account PUT
    • List accounts GET
    • Create an account POST
  • Alert Types
    • List alert types GET
    • Update alert types PUT
  • Alerts
    • Get history of alerts GET
    • List alerts for a booth GET
  • API Keys
    • Delete API key DELETE
    • List API keys GET
    • Create API key POST
  • Events
    • Show notification event definition GET
    • Update an existing event definition PUT
    • Delete an event definition DELETE
    • Mark all user's notifications as read POST
    • Update notification with allowed changes PATCH
    • List event notifications GET
    • Show notification detail GET
    • List notification event definitions GET
    • Create a new event definition POST
  • Login
    • Initiate login attempt POST
    • Authenticate using an API Key POST
    • Verify a magic link token POST
    • Gets the user details of the user making the request GET
  • Booths
    • Get booth's latest values for tags GET
    • Get utilization stats GET
    • List booths GET
    • Get historic runtime GET
    • Get the historic log of filter maintenances for a booth. GET
    • Get utilization timeline GET
    • Get booth recent stages GET
    • Get all booths' last updates GET
    • Get booth by id GET
    • Update booth PUT
    • Get booth runtime GET
    • Get booth revision history GET
    • Get tag history for a booth GET
    • Returns a map with filter options and their possible values GET
    • Export booth data GET
    • Get modes duration GET
    • Get booth's latest values for tags at a given timestamp GET
    • Get utilization summary GET
    • Get modes frequency GET
    • Get a summary per filter type for the booth. GET
  • Facilities
    • Get facility utilization summary GET
    • Get facility details GET
    • Update a facility PUT
    • Get utilization resume of all booths in Facility GET
    • Get frequency utilization resume of all booths in Facility GET
    • Get facility utilization timeline GET
    • List facilities GET
    • Create a facility POST
  • Regions
    • Update a region PUT
    • Delete Region DELETE
    • List regions GET
    • Create a region POST
  • Users
    • Submit a help form POST
    • Update user PUT
    • Update user invitation PUT
    • Re-send user invitation POST
    • Request a password change email POST
    • List users GET
    • Create user POST
  • PLC Provisioning
    • Retrieve a booth's provisioning data GET
    • Update a booth's provisioning data PUT
    • Create a booth provisioning data entry POST
  • Filters
    • Get a summary of filter services per booth GET
    • Get a timeline of utilization crossed with maintenance events information. GET
    • Get the historic log of filter maintenances for all booths in scope. GET
    • Get the trend of time in overuse GET
  • Reports
    • Get a cycles vs in use time report GET
  • Utilization
    • Get utilization trends GET
    • Get the utilization of all booths within scope GET
    • Get the bucketed utilization of all booths within scope GET
Powered by Bump.sh
API changelog
Download source
  • JSON OpenAPI specification
  • YAML OpenAPI specification
Garmat API logo

Reports

Ask AI
  • Open in ChatGPT
  • Open in Claude
  • View as Markdown
  • Copy as Markdown