Overview
Fetch ratings for a location for a given time period (maximum time period is one week)
API
Get ratings
Required Scope: prod/transaction
URL (single location):
Method: GET
Path: /api/ratings/v1/:locationId
Query parameters:
| from-date | Time period start (UTC) |
| to-date | Time period end (UTC) |
Example request:
https://favrit.com/ws/accounting-api-service/api/ratings/v1/1234?from-date=2025-03-01T00%3A00%3A00&to-date=2025-03-07T00%3A00%3A00
Response
data: array[Rating]
Rating:
Keep in mind that many of these fields are optional and may not contain any data. We may also add new fields in the future, so your implementation should be prepared to receive unknown fields and values.
| Field | Type | Description |
| id | uuid | Unique id |
| locationId | numeric | Location id |
| comment | text | Comment left by guest |
| rating | numeric | Star rating 1 - 5 |
| orderReference | text | Order reference |
| category | text | Category selected by guest |
| tableOrDeliveryPoint | text | Point of delivery (table, takeaway etc.) |
| orderCreatedUtc | datetime | When the order was created (not necessarily the same as time of payment) |
| registeredUtc | datetime | When the rating was registered |
| choices | array[text] | Guest may specify which areas the rating applies to |
Model:
Rating (
String id,
Long locationId,
String comment,
Integer rating,
String orderReference,
String category,
String tableOrDeliveryPoint,
LocalDateTime orderCreatedUtc,
LocalDateTime registeredUtc,
List<String> choices
)