Skip to content

Dashboard Exports

Products - Analytics - Dashboard Exports

Get a list of dashboard exports

Request

Get a list of dashboard exports.

Security
X-API-KEY or Authorization
Query
locationIdsstring

List of location IDs to filter by

maxinteger, (int64)

Max number of items to return

offsetinteger, (int64)

Offset used for pagination. Default: 0

curl -i -X GET \
  'https://uberall.com/api/dashboard-exports?locationIds=string&max=0&offset=0' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

List of dashboard exports successfully retrieved

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

The actual response object of the response

Response
{
  "status": "SUCCESS",
  "message": "string",
  "warnings": [
    "string"
  ],
  "response": {
    "offset": 0,
    "max": 10,
    "count": 100,
    "exportDatas": [
      {
        "start": "2019-08-24T14:15:22Z",
        "end": "2019-08-24T14:15:22Z",
        "group": "HOUR",
        "language": "en",
        "token": "string",
        "status": "FINISHED, SCHEDULED, FAILED",
        "locationIds": [
          "string"
        ],
        "whitelabelIdentifier": "string",
        "salesPartnerCountry": "string"
      }
    ]
  }
}