Qualitative evolution
GET/api/v2/reviews/analytics/qualitative
Qualitative evolution
Request
Query Parameters
Default value: week
Default value: true
If cumulative
= false
, return the average rating of reviews from the current bucket only.
If cumulative
= true
, return the average rating of reviews from all the buckets until the current one
(included). The cumulative representation show the evolution of the average rating over time.
Filter by keywords
Return all the reviews with not-nullable content, that contain the provided list of keywords.
Note: This is the content of the review and not the content of the reply.
The filter accepts both simple and composed words.
To indicate it's a composed keyword, add the +
as separator.
For example:
keywords=bonjour
returns all reviews containing the keyword bonjour
keywords=good+service
returns all reviews containing the
combined keyword good service, without splitting the keyword.
No reviews containing just good or just service will be returned.
keywords=bonjour,good+service
: returns all reviews that contain either just bonjour,
either just good service or both keywords at the same time.
Filter by update_date
Return all the reviews whose update_date
>= given_date
.
For example : update_date__gte=2019-01-01T00:00:00
will return all reviews from the first January of 2019
until today.
Note : The update dates are stored in UTC.
Filter by update_date
Return all the reviews whose update_date
<= given_date
.
For example : update_date__lte=2020-01-01T00:00:00
will return all reviews from the date of the first review
until the first january of 2020.
Note : The update dates are stored in UTC.
Filter by business ids
Responses
- 200
- 400
- 401
- 403
- 404
- 422
- 500
This endpoint lets you view the qualitative evolution of the reviews rating for all of your businesses subscribed to Review Management. The API returns the reviews average rating by bucket (time range).
You can use the following filters:
-
by date (analytics before and/or after a date)
-
by businesses (businesses id in list or not in list)
-
by keywords
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
Start date of the bucket
Average rating
Cumulative sum of the number of reviews.
Number of reviews added during the current bucket.
[
{
"date": "2020-07-27",
"average": 0,
"cum_sum": 0,
"added": 0
}
]
- application/json
- Schema
- Example (from schema)
Schema
HTTP status code
Error message
Error name
{
"statusCode": 404,
"message": "Cannot find item",
"error": "Not Found"
}
- application/json
- Schema
- Example (from schema)
Schema
HTTP status code
Error message
Error name
{
"statusCode": 404,
"message": "Cannot find item",
"error": "Not Found"
}
- application/json
- Schema
- Example (from schema)
Schema
HTTP status code
Error message
Error name
{
"statusCode": 404,
"message": "Cannot find item",
"error": "Not Found"
}
- application/json
- Schema
- Example (from schema)
Schema
HTTP status code
Error message
Error name
{
"statusCode": 404,
"message": "Cannot find item",
"error": "Not Found"
}
- application/json
- Schema
- Example (from schema)
Schema
Array [
Array [
]
]
HTTP status code
Error message
errors
object[]
required
Possible values: non-empty
Path to the property with the error
errors
object[]
required
Possible values: non-empty
Error type
Error message
{
"statusCode": 404,
"message": "Cannot find item",
"errors": [
{
"path": "business.id",
"errors": [
{
"type": "object_required_property",
"message": "Required property"
}
]
}
]
}
- application/json
- Schema
- Example (from schema)
Schema
HTTP status code
Error message
Error name
{
"statusCode": 404,
"message": "Cannot find item",
"error": "Not Found"
}