Dashboard

Get customer feedback overview

Changed on

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.

get/dashboard/customer-feedback

Request

  • Base URL
    https://uberall.com/api
  • Auth
    none declared

Query parameters

vunknown
Example:20260713

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

directoryTypeunknown
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 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.

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

Filter strategy to use for scoping locations

textFilterunknown

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.

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

Response

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

OR

Example response

{
  "averageRating": 4.2,
  "countByRating": [
    {
      "rating": 5
    }
  ]
}

Changes

    • info

      added the required property / to the response with the status