Summary of all reviews
GET {{baseUrl}}/v4/reviews/summary?createdAt[gt]=2015-01-23T23:50:07Z&createdAt[gte]=2015-01-23T23:50:07Z&createdAt[lt]=2015-01-23T23:50:07Z&createdAt[lte]=2015-01-23T23:50:07Z&locationUids=00000000-0000-0000-0000-000000000000&locationUids=00000000-0000-0000-0000-000000000000&userUid=00000000-0000-0000-0000-000000000000
Returns a summary of reviews for each location. If no locationUids
parameter is used then the data will be based on all locations that the caller has access to.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
createdAt[gt] | string | Filter on the createdAt date. | |
createdAt[gte] | string | Filter on the createdAt date. | |
createdAt[lt] | string | Filter on the createdAt date. | |
createdAt[lte] | string | Filter on the createdAt date. | |
locationUids | string | List of locations to filter the results by. | |
locationUids | string | List of locations to filter the results by. | |
userUid | string | Filter on the user uid that the reviews are attributed to. |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"data":[{"averageRating":4.839542760372566,"locationUid":"00000000-0000-0000-0000-000000000000","reviewCount":2362},{"averageRating":4.839542760372566,"locationUid":"00000000-0000-0000-0000-000000000000","reviewCount":2362}],"metadata":{"url":"https://www.podium.com/"}}