UBuberall
Dashboard

Trigger async PDF report generation

Triggers asynchronous generation of a PDF report containing insights data and ratings for the filtered locations within the resolved date range. Returns the created job with a SCHEDULED status; the completed report is delivered once generation finishes.

post/dashboard/pdf/export-async

Request

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

Query parameters

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
X-Uberall-Access-Tokenunknown required

Response

Created PDF generation job

statusstring required

Response status

Example response

{
  "status": "SUCCESS"
}

Changes

No operation changes recorded.