Skip to main content

Quantitative evolution

GET 
/api/v2/reviews/analytics/quantitative

Quantitative evolution

Request​

Query Parameters

    bucket stringrequired

    Default value: week

    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 date-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.

    update_date__lte date-time

    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.

    business__in string[]

    Filter by business ids

    Example: [5409c35a97bbc544d8e26737]

Responses​

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

Schema

  • Array [

    • date date

    Start date of the bucket

    cum_sum float

    Cumulative sum of the number of reviews.

    previous_sum float

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

    added number

    Number of reviews added during the current bucket.

  • ]

Loading...