summary of accounts and booths

Summary of accounts and booths

GET /api/accounts/entities_summary

retrieves a summary of the entities in the system for all accounts, as well as of the number of booths in the system, including the number of booths assigned, unassigned, online and active

Responses

200

ok
Hide response attributes Show response attributes object
- active number
  
  Number of booths that have an active mode derived from their last payload
- assigned number
  
  Number of booths assigned to the system
- customers number
  
  Number of customer accounts in the system
- distributors number
  
  Number of distributor accounts in the system
- facilities number
  
  Number of facilities in the system
- online number
  
  Number of booths that have sent a payload in the last 5 minutes
- unassigned number
  
  Number of booths unassigned to the system
- users number
  
  Number of users in the system
401

unauthorized
Hide response attribute Show response attribute object
- error string
  
  Human readable version of the error status code

GET /api/accounts/entities_summary

curl \
 -X GET http://localhost:4000/api/accounts/entities_summary

Response examples (200)

{
  "active": 42.0,
  "assigned": 42.0,
  "customers": 42.0,
  "distributors": 42.0,
  "facilities": 42.0,
  "online": 42.0,
  "unassigned": 42.0,
  "users": 42.0
}

Response examples (401)

{
  "error": "Error Reason"
}

Response examples (401)

{
  "error": "Error Reason"
}