API Reference

Tracks customer feedback, including ratings and tags for quality assessment.

Log in to see full request history

Ratings API

The Ratings API provides insights into customer feedback by tracking ratings and related metrics for specific locations. This API is valuable for monitoring service quality, identifying areas of improvement, and evaluating customer satisfaction across platforms and locations.

Example Response

After a successful call, the API will return results similar to the below structure

[ { "brand_name": "IACM", "location_id": 242303, "country": "United States of America", "external_store_id": null, "order_date": "2024-12-01", "ordering_source": "Doordash", "avg_rating": 5.0, "rating_tags": null, "total_count": null } ]

Field Descriptions

Field NameDescription
brand_nameThe name of the brand associated with the location.
location_idUnique identifier for the specific restaurant location.
countryThe country where the restaurant location is situated.
external_store_idIdentifier for the store in external systems; null if not applicable.
order_dateThe date on which the orders contributing to the ratings were placed.
ordering_sourceThe platform from which the order was received (e.g., DoorDash).
avg_ratingThe average rating received from customer feedback.
rating_tagsTags associated with the ratings, providing additional context; null if not applicable.
total_countThe total number of ratings contributing to the average; null if not applicable.

This API enables businesses to access detailed feedback metrics, aiding in the enhancement of service quality and customer satisfaction.

Query Params
array of int32s
required
Defaults to 11245

External store identifier IDs, such as 11245, should be separated by commas, with a maximum of 200 IDs

location_ids*
string
required
Defaults to 2024-12-01 17:25:00

Start date time in Range of 24 hours

string
required
Defaults to 2024-12-02 17:25:00

End date time in Range of 24 hours

Headers
string
required
Defaults to ab78ef89dsdmnhj35468

Brand token

Responses

Language
Click Try It! to start a request and see the response here! Or choose an example:
application/json