Get Locations' Statistics

Request

Get statistics about the locations the current user is managing: total and breakdown by status

Security

X-API-KEY or Authorization

curl -i -X GET \
  https://uberall.com/api/locations/statistics \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Location statistics successfully retrieved

Bodyapplication/json

countinteger, (int32)

Total number of locations

countActiveinteger, (int32)

Number of active locations

countInactiveinteger, (int32)

Number of inactive locations

countCancelledinteger, (int32)

Number of cancelled locations

countClosedinteger, (int32)

Number of closed locations

countSyncStartedinteger, (int32)

Number of locations where sync has been started

countSyncNotStartedinteger, (int32)

Number of locations where sync has not been started

countSyncNeededinteger, (int32)

Number of locations where sync is needed

suggestionsAvailableboolean

true if any suggetions are available

Response

{
  "count": 0,
  "countActive": 0,
  "countInactive": 0,
  "countCancelled": 0,
  "countClosed": 0,
  "countSyncStarted": 0,
  "countSyncNotStarted": 0,
  "countSyncNeeded": 0,
  "suggestionsAvailable": true
}