Skip to main content

Statistics for reviews

GET 
/api/v2/reviews/analytics

This endpoint let you view the global reviews statistics for all your businesses subscribed to Review Management.

You can use the following filters:

  • by date (statistics before and/or after a date)
  • by businesses (businesses id in list or not in list)
  • by keywords

The response is aggregated according to the previously selected filters.

In order to get analytics evolution overtime returned by specific time range, please refer to Qualitative Evolution and Quantitative Evolution endpoints.

Request​

Query Parameters

    business__in string[]

    Filter by business

    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.

    Example: 2019-01-01T00:00:00
    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.

    Example: 2020-01-01T00:00:00

Responses​

Schema

    answer_time number

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

    average number

    Average reviews rating.

    treated number

    Total number of treated reviews.

    not_treated number

    Total number of non treated reviews.

    answered number

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

    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.

    neutral number

    Total number of reviews of type neutral.

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

    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.

    total number

    Total number of reviews.

Loading...