Skip to main content
GET
/
reviews
/
qualitative-evolution
Qualitative evolution
curl --request GET \
  --url https://api.partoo.co/v2/reviews/qualitative-evolution \
  --header 'x-APIKey: <api-key>'
[
  {
    "date": "2019-11-29",
    "average": 4.54,
    "added": 50,
    "cum_sum": 70
  },
  {
    "date": "2019-12-05",
    "average": 4.34,
    "added": 34,
    "cum_sum": 104
  },
  {
    "date": "2019-12-12",
    "average": 4.41,
    "added": 4,
    "cum_sum": 108
  }
]

Authorizations

​
x-APIKey
string
header
required

The authentication system on Partoo API is using API Key that should be put in the header of the request (the name of the header is x-APIKey). An api_key is linked to a user. This user's role will give you different access level to the API features.

Query Parameters

​
bucket
enum<string>
default:week

Defining the time range of a data bucket.

This will determine the precision of the returned data. For example, if you choose day, you will receive the number of reviews for each day.

Available options:
day,
week,
month,
year
​
cumulative
enum<string>
default: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.

Available options:
true,
false
​
business__in
string[]

Filter by business ids

Return the reviews of the businesses given in list.

Business id

​
keywords
string[]

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.
Example:

"bonjour,good+service"

​
update_date__gte
string<datetime>

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.

Example:

"2017-08-01T00:00:00"

​
update_date__lte
string<datetime>

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.

Example:

"2017-08-02T00:00:00"

Response

OK

​
date
string<datetype>

Start date of the bucket

​
average
number

Average rating.

​
added
integer

Number of reviews added during the current bucket.

​
cum_sum
number

Cumulative sum of the number of reviews.