Get Historical Visibility Index

Request

Get a Visibility Index time series. Only days where the Visibility Index changed will be returned

Security

X-API-KEY or Authorization

Path

idstringrequired

The uberall unique id of the location you want the Visibility Index for

Query

startDatestring, (date)

startDate in YYYY-MM-dd

endDatestring, (date)

endDate in YYYY-MM-dd

curl -i -X GET \
  'https://uberall.com/api/locations/{id}/visibility-indexes/interesting?startDate=2019-08-24&endDate=2019-08-24' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Historical 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": {
    "indexes": [ … ]
  }
}