Sign in

v1

latestOpenAPI 3.0.1Licensed under Uberall2026-08-0629353914.0 MB
Dashboard

Export insights data with threshold

Generates an Excel report and uploads it to S3. If the report completes within the timeout, returns the file URL directly (status=FINISHED). If it exceeds the timeout, the export continues in the background and the user is notified by email (status=EMAIL). Returns status=FAILED on error. Defaults to the last week if startDate is not provided.

get/dashboard/export-insights-data-with-threshold

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 is deprecated (was only for ACTIONS-PHONE) and now maps to DAILY.

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

Filter strategy to use for scoping locations

{"stackTrail":"paths:/dashboard/export-insights-data-with-threshold:get:parameters:5:schema","oasType":"schema","type":"unknown"}

Deprecated: use the newer query parameter instead. Free-text location search that narrows results to matching locations (matches name, address, identifier and label fields). Supports #label and @group tokens (e.g. "main st #premium @north"), combined with AND semantics. Applied only when no filterCategory is set.

{"stackTrail":"paths:/dashboard/export-insights-data-with-threshold:get:parameters:6:schema","oasType":"schema","type":"unknown"}

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

{"stackTrail":"paths:/dashboard/export-insights-data-with-threshold:get:parameters:7:schema","oasType":"schema","type":"unknown"}

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

{"stackTrail":"paths:/dashboard/export-insights-data-with-threshold:get:parameters:8:schema","oasType":"schema","type":"unknown"}

Label names (used when filterCategory=labels)

{"stackTrail":"paths:/dashboard/export-insights-data-with-threshold:get:parameters:9:schema","oasType":"schema","type":"unknown"}

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

{"stackTrail":"paths:/dashboard/export-insights-data-with-threshold:get:parameters:10:schema","oasType":"schema","type":"unknown"}

Comma-separated location IDs to exclude from results

{"stackTrail":"paths:/dashboard/export-insights-data-with-threshold:get:parameters:11:schema","oasType":"schema","type":"unknown"}

Comma-separated business IDs to exclude from results

{"stackTrail":"paths:/dashboard/export-insights-data-with-threshold:get:parameters:12:schema","oasType":"schema","type":"unknown"}

Label names to exclude from results

{"stackTrail":"paths:/dashboard/export-insights-data-with-threshold:get:parameters:13:schema","oasType":"schema","type":"unknown"}

Location group IDs to exclude from results

Headers

{"stackTrail":"paths:/dashboard/export-insights-data-with-threshold:get:parameters:0:schema","oasType":"schema","type":"unknown"}

Response

Export status with optional file URL