Get a Location's Dashboard

Get a Location's Dashboard
deprecated

Request

Deprecated. Use the dedicated Dashboard endpoints instead — see docs.uberall.com/apis/swagger/dashboard. Manager counts and next-best-actions have no replacement.

Security

X-API-KEY or Authorization

Path

idstringrequired

The uberall unique id of the location you want a dashboard for

curl -i -X GET \
  'https://uberall.com/api/locations/{id}/dashboard' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Location dashboard successfully retrieved

Bodyapplication/json

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

The actual response object of the response

Response

{
  "status": "SUCCESS",
  "message": "string",
  "warnings": [
    "string"
  ],
  "response": {
    "dashboard": { … }
  }
}