Skip to content

Get Businesses' Statistics

Request

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

Security
X-API-KEY or Authorization
curl -i -X GET \
  https://uberall.com/api/businesses/statistics \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Successfully retrieved Business Statistics

Body*/*
statusstringrequired
Enum:"SUCCESS""PENDING""QUOTA_LIMIT_EXCEED""NOT_AUTHORIZED""FORBIDDEN""BAD_ACCESS_TOKEN""BAD_PRIVATE_KEY""BAD_PUBLIC_KEY""MISSING_PARAMETER""INVALID_PARAMETER"
messagestring

(optional) Holds further information about the response

warningsArray of strings

(optional) Holds further warnings

responseobjectrequired

Business Statistics Model

Response
{
  "status": "SUCCESS",
  "message": "string",
  "warnings": [
    "string"
  ],
  "response": {
    "count": 0,
    "countActive": 0,
    "countWithoutLocations": 0,
    "countWithLocations": 0
  }
}