Get search keywords

Request

Retrieves the top search keywords that led users to find the filtered locations within a date range. Each keyword includes its occurrence count. Defaults to the last week if startDate is not provided.

Query

startDateany

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.

Example:startDate=2025-01-01

endDateany

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.

Example:endDate=2025-03-31

groupany

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.

Enum:"DAILY""WEEKLY""MONTHLY""QUARTERLY""YEARLY""HOUR""DAY""WEEK""MONTH""YEAR"

Example:group=MONTHLY

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

curl -i -X GET \
  'https://uberall.com/api/dashboard/search-keywords?startDate=2025-01-01&endDate=2025-03-31&group=MONTHLY&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'

Responses

Search keywords ranked by occurrence count

Body*/*

statusanyrequired

Response status

Example:"SUCCESS"

responseobjectrequired

Response payload

Response

{
  "status": "SUCCESS",
  "response": {
    "keywords": [
      {
        "keyword": "pizza near me",
        "value": null
      }
    ],
    "total": null,
    "parameters": {
      "startMonth": null,
      "startYear": null,
      "endMonth": null,
      "endYear": null,
      "currentMonth": null,
      "currentMonthUnlockDate": null,
      "previousMonth": null,
      "previousMonthUnlockDate": null,
      "limitStartMonth": null,
      "limitStartYear": null,
      "limitEndMonth": null,
      "limitEndYear": null
    }
  }
}