Sign in

v1

latestOpenAPI 3.1.0© Copyright Partoo2026-07-26163503484.0 KB
Review analytics

Quantitative evolution

This endpoint lets you view the quantitative evolution of the number of reviews for all of your businesses subscribed to Review Management. The API returns the cumulative sum of the number of reviews by bucket (time range) selected overtime.

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
get/reviews/quantitative-evolution

Query parameters

bucket'day' | 'week' | 'month' | 'year'

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.

business__inBusinessId[]

Filter by business ids

Return the reviews of the businesses given in list.

[
  "5409c35a97bbc544d8e26737"
]
keywordsstring[]

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.
update_date__gtestring datetime
Example:2017-08-01T00:00:00

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.

update_date__ltestring datetime
Example:2017-08-02T00:00:00

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.

Response

OK

datestring datetype

Start date of the bucket

addedinteger

Number of reviews added during the current bucket.

previous_sumnumber float

Cumulative sum of the number of reviews for the previous bucket.

cum_sumnumber float

Cumulative sum of the number of reviews.

Example response

[
  {
    "date": "2019-11-29",
    "added": 50,
    "previous_sum": 20,
    "cum_sum": 70
  },
  {
    "date": "2019-12-05",
    "added": 34,
    "previous_sum": 70,
    "cum_sum": 104
  },
  {
    "date": "2019-12-12",
    "added": 4,
    "previous_sum": 104,
    "cum_sum": 108
  }
]