Trigger async PDF report generation

Request

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.

Query

filterCategoryany

Filter strategy to use for scoping locations

Enum:"location""business""labels""location-groups"

locationIdsany

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

businessIdsany

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

labelsany

Label names (used when filterCategory=labels)

locationGroupIdsany

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

excludedLocationIdsany

Comma-separated location IDs to exclude from results

excludedBusinessIdsany

Comma-separated business IDs to exclude from results

excludedLabelsany

Label names to exclude from results

excludedLocationGroupIdsany

Location group IDs to exclude from results

X-Uberall-User-Idany, (int64)required

X-Uberall-Access-Tokenanyrequired

curl -i -X POST \
  'https://uberall.com/api/dashboard/pdf/export-async?filterCategory=location&locationIds=%7BlocationIds%7D&businessIds=%7BbusinessIds%7D&labels=%7Blabels%7D&locationGroupIds=%7BlocationGroupIds%7D&excludedLocationIds=%7BexcludedLocationIds%7D&excludedBusinessIds=%7BexcludedBusinessIds%7D&excludedLabels=%7BexcludedLabels%7D&excludedLocationGroupIds=%7BexcludedLocationGroupIds%7D' \
  -H 'X-Uberall-Access-Token: {X-Uberall-Access-Token}' \
  -H 'X-Uberall-User-Id: {X-Uberall-User-Id}'

Responses

Created PDF generation job

Body*/*

statusanyrequired

Response status

Example:"SUCCESS"

responseobjectrequired

Response payload

Response

{
  "status": "SUCCESS",
  "response": {
    "id": null,
    "start": null,
    "end": null,
    "language": null,
    "status": "SCHEDULED",
    "whitelabelIdentifier": null,
    "salesPartnerCountry": null
  }
}