Get Location's Visibility Index

Request

Get the latest location's visibility index

Security

X-API-KEY or Authorization

Path

idstringrequired

The uberall unique id for the location

Query

daysstring

Use days to get the visibility index from as many days ago

curl -i -X GET \
  'https://uberall.com/api/locations/{id}/visibility-indexes?days=string' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Visibility indexes 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": {
    "visibilityIndex": { … }
  }
}