Skip to content
API Reference
/
Dashboard Exports
/
Invoke a creation of a dashboard export

Uberall API (20250204)

Enhance your application with Uberall's comprehensive API documentation

Download OpenAPI description
swagger.json
swagger.yaml
Overview
URL

https://uberall.com

Support

api@uberall.com

License

Licensed under Uberall

Languages
Servers
Mock server

https://docs.uberall.com/_mock/apis/swagger/

https://uberall.com/api/

Users

Set up - Users

Operations

Business Connections

Set up - Business Connections

Operations

Businesses

Set up - Businesses

Operations

Configuration

Set up - Configuration

Operations

Sales Partners

Set up - Tenancy - Sales Partners

Operations

Monitoring

Set up - API Status

Operations

Product Plans

Set up - Tenancy - Product Plans

Operations

Webhooks

Set up - Tenancy - Sales Partners - Webhooks

Operations

Auto Response

Products - Auto Response

Operations

Brand Data Points

Products - Brand Data Points

Operations

Dashboard

Products - Analytics - Dashboard

Operations

Dashboard Exports

Products - Analytics - Dashboard Exports

Operations

Get a list of dashboard exports

Request

Get a list of dashboard exports.

Security
accessToken or privateKey
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://docs.uberall.com/_mock/apis/swagger/dashboard-exports?locationIds=string&max=0&offset=0' \
  -H 'accessToken: YOUR_API_KEY_HERE'

Responses

List of dashboard exports successfully retrieved

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

(optional) Holds further information about the response

warningsArray of strings

(optional) Holds further warnings

responseobjectrequired

The actual response object of the response

response.​offsetinteger(int32)

The offset for pagination

Example: 0
response.​maxinteger(int32)

The maximum number of results to return

Example: 10
response.​countinteger(int32)

The total count of export data

Example: 100
response.​exportDatasArray of objects(DashboardExportData)
Response
No content

Invoke a creation of a dashboard export

Request

Invoke creation of a dashboard export (in PDF format) asynchronously.

Security
accessToken or privateKey
Query
startstringrequired

Start date of export, in yyyy-MM-dd format

Example: start=2017-01-01
endstringrequired

End date of export, in yyyy-MM-dd format

Example: end=2017-12-31
groupstringrequired

Grouping of the historical data

whitelabelIdentifierstringrequired

Whitelabel identifier string

locationIdsstringrequired

List of location IDs

languagestringrequired

Language identifier (i.e. 'fr', 'de')

Example: language=fr
Body*/*
object(CreatePDFValidatorCommand)
curl -i -X POST \
  'https://docs.uberall.com/_mock/apis/swagger/dashboard-exports?start=2017-01-01&end=2017-12-31&group=string&whitelabelIdentifier=string&locationIds=string&language=fr' \
  -H 'Content-Type: */*' \
  -H 'accessToken: YOUR_API_KEY_HERE' \
  -d '[object Object]'

Responses

Export data created successfully

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

(optional) Holds further information about the response

warningsArray of strings

(optional) Holds further warnings

responseobjectrequired

Dashboard Export Data

response.​startstring(date-time)

Start date of export

response.​endstring(date-time)

End date of export

response.​groupstring

A time grouping parameter among HOUR, DAY, WEEK, MONTH, YEAR

Enum"HOUR""DAY""WEEK""MONTH""YEAR"
response.​languagestring

Language of a generated PDF report (e.g. 'de', 'fr', 'en')

Example: "en"
response.​tokenstring

Token of the export job

response.​statusstring

Current status of the export process (e.g. 'FINISHED', 'SCHEDULED', 'FAILED')

Enum"CREATED""SCHEDULED""FAILED""FINISHED"
Example: "FINISHED, SCHEDULED, FAILED"
response.​locationIdsArray of stringsunique

A list of location IDs for which to generate a report

response.​whitelabelIdentifierstring

Whitelabel identifier which will be used in the outline of the PDF report

response.​salesPartnerCountrystring

Country of the SalesPartner

Response
No content

Download the result of a dashboard export (a PDF file)

Request

Download the result of a dashboard export (a PDF file).

Security
accessToken or privateKey
Path
idstringrequired

DashboardExportData Id

curl -i -X GET \
  'https://docs.uberall.com/_mock/apis/swagger/dashboard-exports/{id}/download' \
  -H 'accessToken: YOUR_API_KEY_HERE'

Responses

PDF file successfully downloaded

Bodyapplication/pdf
string(binary)
Response
No content

Data Points

Products - Data Points

Operations

Data Point Filters

Products - Data Points - Data Point Filters

Operations

Templates

Products - Response Library - Templates

Operations

Social Posting

Products - Social Posting

Operations

Digital Asset Management

Products - Digital Asset Management

Operations

Status Check

Products - Status Check

Operations

Store Finder

Products - Store Finder

Operations

Batch Operation

Locations Hub - Locations - Batch Operations (excel)

Operations

Categories

Locations Hub - Categories

Operations

Collection Management

Locations Hub - Collections - Collection Management

Operations

Content List

Locations Hub - Collections - Content List

Operations

Locations Data

Locations Hub - Locations Data

Operations

Custom Items

Locations Hub - Collections - Custom Items

Operations

Events

Locations Hub - Collections - Events

Operations

Listings

Locations Hub - Locations - Listings

Operations

Labels

Locations Hub - Labels

Operations

Location Groups

Locations Hub - Location Groups

Operations

Persons

Locations Hub - Locations - Persons

Operations

Locations Photos

Locations Hub - Locations Photos

Operations

Products

Locations Hub - Locations - Product

Operations

Service Items

Locations Hub - Locations - Service Items

Operations

Suggestions

Locations Hub - Locations - Suggestions

Operations