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

KeyDatatypeRequiredDescription
createdAt[gt]stringFilter on the createdAt date.
createdAt[gte]stringFilter on the createdAt date.
createdAt[lt]stringFilter on the createdAt date.
createdAt[lte]stringFilter on the createdAt date.
locationUidsstringList of locations to filter the results by.
locationUidsstringList of locations to filter the results by.
userUidstringFilter on the user uid that the reviews are attributed to.

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

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/"}}