Get customer feedback overview

Request

Retrieves aggregated customer review statistics including average rating, count by each star rating, reply counts, and contributing directory types. Optionally filters by a specific directory type. Defaults to all available data (from 1970-01-01 up to today) if startDate is not provided.

Query

vany

API version. Defaults to the latest version. Versions older than 20260713 additionally return interactionCount, unreadInteractionCount and unreadInteractions.

Example:v=20260713

directoryTypeany

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"

textFilteranydeprecated

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.

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/customer-feedback?v=20260713&directoryType=%7BdirectoryType%7D&startDate=2025-01-01&endDate=2025-03-31&group=MONTHLY&filterCategory=location&textFilter=%7BtextFilter%7D&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

Aggregated feedback statistics with rating breakdown. Versions older than 20260713 also include interactionCount, unreadInteractionCount and unreadInteractions.

Bodyapplication/json

One of:

Aggregated customer feedback statistics

averageRatingany, (double)required

Average rating across all reviews

Example:4.2

countByRatingArray of objectsrequired

Review count breakdown by star rating (1-5)

ratingCountany, (int32)required

Total number of ratings

repliedCountany, (int32)required

Number of reviews that received a reply

directoryTypesArray of objectsrequired

Directory types that contributed reviews

Response

{
  "averageRating": 4.2,
  "countByRating": [
    { … }
  ],
  "ratingCount": null,
  "repliedCount": null,
  "directoryTypes": [
    { … }
  ]
}