UBuberall
Dashboard

Create Excel export job

Creates an asynchronous Excel export job for the filtered locations and returns the job identifier. The report is generated in the background; use the returned job id to poll its status and download the file once ready. Defaults to the last week if startDate is not provided.

post/dashboard/excel-exports

Request

  • Base URL
    https://uberall.com/api
  • Auth
    none declared. Required headers: X-Uberall-User-Id

Query parameters

startDatestring
Example:2025-01-01

Start date (inclusive) as an ISO-8601 date or date-time, with or without zone/offset (e.g. 2025-01-01, 2025-01-01T14:30:00, 2025-01-01T14:30:00Z, 2025-01-01T14:30:00%2B02:00). Zone-aware values are normalised to UTC. The formats yyyy.MM.dd, dd.MM.yyyy, dd-MM-yyyy HH:mm:ss and dd.MM.yyyy HH:mm:ss are also accepted. Optional for most endpoints — defaults to a period before end date if omitted.

endDatestring
Example:2025-03-31

End date (inclusive) as an ISO-8601 date or date-time, with or without zone/offset. Zone-aware values are normalised to UTC. The formats yyyy.MM.dd, dd.MM.yyyy, dd-MM-yyyy HH:mm:ss and dd.MM.yyyy HH:mm:ss are also accepted. Defaults to today.

group'DAILY' | 'WEEKLY' | 'MONTHLY' | 'QUARTERLY' | 'YEARLY' | 'HOUR' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR'
Example:MONTHLY

Overrides the automatic granularity of the date range. Case-insensitive. When omitted, granularity is derived from the range length. Legacy values DAY, WEEK, MONTH and YEAR are also accepted. HOUR returns the whole range as a single bucket holding the ACTIONS_PHONE hour-of-day profile (phone0..phone23) and is only valid for the ACTIONS_PHONE metric; other endpoints treat it as DAILY.

filterCategory'location' | 'business' | 'labels' | 'location-groups'

Filter strategy to use for scoping locations

locationIdsunknown

Comma-separated location IDs (used when filterCategory=location)

businessIdsunknown

Comma-separated business IDs (used when filterCategory=business)

labelsunknown

Label names (used when filterCategory=labels)

locationGroupIdsunknown

Location group IDs (used when filterCategory=location-groups)

excludedLocationIdsunknown

Comma-separated location IDs to exclude from results

excludedBusinessIdsunknown

Comma-separated business IDs to exclude from results

excludedLabelsunknown

Label names to exclude from results

excludedLocationGroupIdsunknown

Location group IDs to exclude from results

Headers

X-Uberall-User-Idunknown required

Response

Created export job with its identifier

statusstring required

Response status

Example response

{
  "status": "SUCCESS"
}

Changes

No operation changes recorded.