Skip to main content
GET
/
reviews
/
stats
Global reviews statistics
curl --request GET \
  --url https://api.partoo.co/v2/reviews/stats \
  --header 'x-APIKey: <api-key>'
{
  "answer_time": 10493.90997409,
  "average": 3.0394,
  "treated": 9,
  "not_treated": 10,
  "answered": 8,
  "satisfied": 10,
  "neutral": 6,
  "dissatisfied": 3,
  "total": 19
}

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

​
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

​
answer_time
number

Average reviews answer time in seconds. Only measured for reviews with a comment from Google partner. It returns the time between the update date of a review and the creation date of its comments.

Example:

10493.90997409

​
average
number

Average reviews rating.

Required range: 0 <= x <= 5
Example:

3.0394

​
treated
number

Total number of treated reviews.

Example:

9

​
not_treated
number

Total number of non treated reviews.

Example:

10

​
answered
number

Total number of answered reviews (reviews with a comment).

Example:

8

​
satisfied
number

Total number of reviews of type satisfied.

Satisfied reviews are defined by a rating of 4 or more for google_my_business and tripadvisor or recommended for facebook.

Example:

10

​
neutral
number

Total number of reviews of type neutral.

Neutral reviews are defined by a rating of 3 for google_my_business and tripadvisor.

Example:

6

​
dissatisfied
number

Total number of reviews of type dissatisfied.

Dissatisfied reviews are defined by a rating of 2 or less for google_my_business and tripadvisor or not recommended for facebook.

Example:

3

​
total
number

Total number of reviews.

Example:

19