API Reference
/
Dashboard
/
Get Customer Feedback by Period

Uberall API (20250204)

Enhance your application with Uberall's comprehensive API documentation

Download OpenAPI description
swagger.json
swagger.yaml
Overview
URL

https://uberall.com

Support

api@uberall.com

License

Licensed under Uberall

Languages
Servers
Mock server

https://docs.uberall.com/_mock/apis/swagger/

https://uberall.com/api/

Users

Set up - Users

Operations

Business Connections

Set up - Business Connections

Operations

Businesses

Set up - Businesses

Operations

Configuration

Set up - Configuration

Operations

Sales Partners

Set up - Tenancy - Sales Partners

Operations

Monitoring

Set up - API Status

Operations

Product Plans

Set up - Tenancy - Product Plans

Operations

Webhooks

Set up - Tenancy - Sales Partners - Webhooks

Operations

Auto Response

Products - Auto Response

Operations

Brand Data Points

Products - Brand Data Points

Operations

Dashboard

Products - Analytics - Dashboard

Operations

Get Customer Feedback

Request

Get the Customer Feedback of the user managed locations filtered by the given ids

Query
businessIdsArray of integers(int64)

The ids of the businesses you want customer feedback for

locationIdsArray of integers(int64)

The ids of the locations you want customer feedback data for

textFilterstring

Filter locations to get customer feedback for by name, zip, street, city, label

Example: textFilter=Berlin
typestring

The directory you want customer feedback data for

startDatestring(date)

The start date

endDatestring(date)

The end date

curl -i -X GET \
  'https://docs.uberall.com/_mock/apis/swagger/dashboard/customer-feedback?businessIds=0&endDate=2019-08-24&locationIds=0&startDate=2019-08-24&textFilter=Berlin&type=string' \
  -H 'accessToken: YOUR_API_KEY_HERE'

Responses

Successfully retrieved customer feedback

Body*/*
statusstringrequired
Enum"SUCCESS""QUOTA_LIMIT_EXCEED""NOT_AUTHORIZED""FORBIDDEN""BAD_ACCESS_TOKEN""BAD_PRIVATE_KEY""BAD_PUBLIC_KEY""MISSING_PARAMETER""INVALID_PARAMETER""WRONG_PARAMETER_TYPE"
messagestring

(optional) Holds further information about the response

warningsArray of strings

(optional) Holds further warnings

responseobjectrequired

CustomerFeedback Model

response.​countByRatingArray of objects(CountByRatingDetails)

Average count by rating

response.​ratingCountinteger(int32)

The total count of rating

response.​repliedCountinteger(int32)

The count of replied reviews

response.​averageRatingnumber(float)

Average rating obtained

response.​interactionCountinteger(int32)

The number of review and photos

response.​unreadInteractionCountinteger(int32)

The number of reviews and photos unread

response.​unreadInteractionsArray of objects(DataPoint)

The reviews and photos unread

response.​matchedLocationsCountinteger(int32)

The number of locations matching the given textFilter query

Response
No content

Get Customer Feedback by Period

Request

Get the Customer Feedback of the user managed locations filtered by the given ids grouped by period

Query
businessIdsArray of integers(int64)

The ids of the businesses you want customer feedback by period for

locationIdsArray of integers(int64)

The ids of the locations you want customer feedback by period data for

textFilterstring

Filter locations to get customer feedback by period for by name, zip, street, city, label

Example: textFilter=Berlin
typestring

The directory you want customer feedback by period data for

startDatestring(date)

The start date

endDatestring(date)

The end date

groupstring

How to group the results, one of: DAY, WEEK, MONTH, YEAR

curl -i -X GET \
  'https://docs.uberall.com/_mock/apis/swagger/dashboard/customer-feedback-by-period?businessIds=0&endDate=2019-08-24&group=string&locationIds=0&startDate=2019-08-24&textFilter=Berlin&type=string' \
  -H 'accessToken: YOUR_API_KEY_HERE'

Responses

Successfully retrieved customer feedback by period

Body*/*
statusstringrequired
Enum"SUCCESS""QUOTA_LIMIT_EXCEED""NOT_AUTHORIZED""FORBIDDEN""BAD_ACCESS_TOKEN""BAD_PRIVATE_KEY""BAD_PUBLIC_KEY""MISSING_PARAMETER""INVALID_PARAMETER""WRONG_PARAMETER_TYPE"
messagestring

(optional) Holds further information about the response

warningsArray of strings

(optional) Holds further warnings

responseobjectrequired

CustomerFeedbackByPeriod Model

response.​interactionCountByPeriodArray of objects(InteractionCountByPeriodDetails)

The number of reviews and photos unread by period

response.​averageRatingByPeriodArray of objects(TimeSeriesSegment)

The average ratings of the incoming reviews in the given time periods of the total time span.

response.​matchedLocationsCountinteger(int32)

The number of locations matching the given textFilter query

response.​totalRatingCountinteger(int32)

The total number of reviews with rating in the given time span.

Response
No content

Get Customer Feedback Keywords.

Request

Returns the 100 most mentioned Keywords and the average Rating of the Reviews where they appeared.

Query
businessIdsArray of integers(int64)

The ids of the businesses you want customer feedback keywords for

locationIdsArray of integers(int64)

The ids of the locations you want customer feedback keywords data for

textFilterstring

Filter locations to get customer feedback keywords for by name, zip, street, city, label

Example: textFilter=Berlin
startDatestring(date)

The start date

endDatestring(date)

The end date

curl -i -X GET \
  'https://docs.uberall.com/_mock/apis/swagger/dashboard/customer-feedback-keywords?businessIds=0&endDate=2019-08-24&locationIds=0&startDate=2019-08-24&textFilter=Berlin' \
  -H 'accessToken: YOUR_API_KEY_HERE'

Responses

Successfully retrieved customer feedback keywords

Body*/*
statusstringrequired
Enum"SUCCESS""QUOTA_LIMIT_EXCEED""NOT_AUTHORIZED""FORBIDDEN""BAD_ACCESS_TOKEN""BAD_PRIVATE_KEY""BAD_PUBLIC_KEY""MISSING_PARAMETER""INVALID_PARAMETER""WRONG_PARAMETER_TYPE"
messagestring

(optional) Holds further information about the response

warningsArray of strings

(optional) Holds further warnings

responseobjectrequired

CustomerFeedbackKeyword Model

response.​keywordsArray of objects(CustomerFeedbackKeyword)

The list of keywords

response.​totalFeedbacksAnalyzedinteger(int32)

The total number of Feedbacks that have been analyzed.

Response
No content

Dashboard Exports

Products - Analytics - Dashboard Exports

Operations

Data Points

Products - Data Points

Operations

Data Point Filters

Products - Data Points - Data Point Filters

Operations

Templates

Products - Response Library - Templates

Operations

Social Posting

Products - Social Posting

Operations

Social Posting Templates

Products - Social Posting - Social Posting Templates

Operations

Digital Asset Management

Products - Digital Asset Management

Operations

Status Check

Products - Status Check

Operations

Store Finder

Products - Store Finder

Operations

Batch Operation

Locations Hub - Locations - Batch Operations (excel)

Operations

Categories

Locations Hub - Categories

Operations

Collection Management

Locations Hub - Collections - Collection Management

Operations

Content List

Locations Hub - Collections - Content List

Operations

Locations Data

Locations Hub - Locations Data

Operations

Custom Items

Locations Hub - Collections - Custom Items

Operations

Events

Locations Hub - Collections - Events

Operations

Listings

Locations Hub - Locations - Listings

Operations

Labels

Locations Hub - Labels

Operations

Location Groups

Locations Hub - Location Groups

Operations

Menu Items

Locations Hub - Locations - Menu Items

Operations

Persons

Locations Hub - Locations - Persons

Operations

Locations Photos

Locations Hub - Locations Photos

Operations

Products

Locations Hub - Locations - Product

Operations

Service Items

Locations Hub - Locations - Service Items

Operations

Suggestions

Locations Hub - Locations - Suggestions

Operations