--- title: "Get Review metrics" method: GET path: "/review_analytics/metrics" tags: ["Review analytics"] --- # Get Review metrics `GET /review_analytics/metrics` **⚠️ This feature is available only for businesses subscribed to Review Management. ⚠️** All the operations to perform Reviews analytics. This endpoint lets you view the statistics related to reviews made to your businesses subscribed to **Review Management**. A request is composed of: - One or more `metrics` which is the data you want to return - An optional `dimensions` which defines how the data is grouped by - If it is omitted, the request will return the metrics over all the data, based on your filters - An optional `order_by` to define how the data is sorted - Filters, the data can be filtered by: - Businesses - Groups - Tags - Review update date Here is the list of all **metrics** available: - `average_rating`: Average rating - `rating_distribution`: Breakdown of the ratings (Number of 1-star reviews, 2-star reviews, 3-star reviews, etc...) - `reviews_count`: Number of reviews received - `reply_time`: Breakdown of the reviews based on how fast (less or more than 48 hours) they have been replied to (or not replied) - `reply_means`: Breakdown of the review replies based on the reply method used (manual reply, reply template, auto reply or AI suggestion) - `average_rating_distribution`: Breakdown of your businesses based on their average rating - `rank`: Allows you to rank the users, businesses or groups based on their performance on a metric (an order_by is required) Here is the list of all **dimensions** available, and for each of them, the list of metrics and sort order available: - No dimension - This allows you to get global stats across all your businesses - Available metrics: `average_rating`, `rating_distribution`, `reviews_count`, `reply_time`, `reply_means`, `average_rating_distribution` - Date dimensions: `day`, `week`, `month`, `year` - This allows you to get the evolution of your metrics over time - Available metrics: `average_rating`, `rating_distribution`, `reviews_count`, `reply_time`, `reply_means` - Business and business group dimensions: `business`, `group` - This allows you to see the metrics business by business or group by group (Requires group filter) - Available metrics: `average_rating`, `rating_distribution`, `reviews_count`, `reply_time`, `reply_means`, `rank` - `user` - This allows you to see the metrics user by user - Available metrics: `reply_time`, `reply_means`, `rank` - `tag` - This allows you to see the metrics tag by tag - Available metrics: `average_rating`, `rating_distribution`, `reviews_count` Here is the list of all **order_by** available (Add a minus `-` sign before to order by decreasing order): - `average_rating`: Sort by average rating - `reviews_count`: Sort by review_count - `reply_time__total`: Sort by number of reviews received - `reply_means__total`: Sort by number of reviews that have been replied - `ratio__rating_distribution__5`: Sort by the ratio of 5 star reviews - `ratio__rating_distribution__negative`: Sort by the ratio of negative reviews - `ratio__reply_time__fast`: Sort by the ratio of reviews replied in less than 2 days - `ratio__reply_time__slow`: Sort by the ratio of reviews replied in more than 2 days - `ratio__reply_time__not_replied`: Sort by the ratio of reviews not replied - `ratio__reply_means__manual`: Sort by the ratio reviews replied manually - `ratio__reply_means__ai_suggestion`: Sort by the ratio reviews replied using AI suggestion - `ratio__reply_means__reply_template`: Sort by the ratio reviews replied using reply template - `ratio__reply_means__auto_reply`: Sort by the ratio reviews replied using auto reply To use an **order_by** parameter, its corresponding metric must be included in the request. (i.e. to order by `average_rating`, you must include the `average_rating` metric in the `metrics` parameter, to order by `ratio__rating_distribution__5`, you must include the `rating_distribution` metric in the `metrics` parameter, and so on...) ## Query parameters - `metrics` 'average_rating' | 'rating_distribution' | 'reviews_count' | 'reply_time' | 'reply_means' | 'average_rating_distribution' | 'rank', required - `dimensions` 'day' | 'week' | 'month' | 'year' | 'business' | 'group' | 'user' | 'tag' - `order_by` string - `business__in` BusinessID[] - `business__notin` BusinessID[] - `groups` GroupID[] - `tags` TagID[] - `update_date__gte` string, datetime - `update_date__lte` string, datetime - `page` integer - `per_page` integer ## Response `200` OK - object - `page` integer — Current page number - `max_page` integer — Last page number - `count` integer — Number of resources complying with filters - `data` ReviewMetricsResponse[] - `dimension` union, required — Unique identifier of the dimension: - **string** when `dimensions` is `business`, `user`, `day`, `week`, `month`, `year`. - **number** when `dimensions` is `group` or `tag`. - **null** when `dimensions` is not set. When `dimensions` is `day` or `week`, the format is `YYYY-MM-DD` When `dimensions` is `month`, the format is `YYYY-MM` When `dimensions` is `year`, the format is `YYYY` - string - number - `metrics` object, required - `average_rating` number, float — Average rating. - `average_rating_distribution` object — Number of businesses within each pre-defined ratings. - `NULL` number — Number of businesses without any average rating. - `0-3` number — Number of businesses whose rating is between 0 and 3 (excluded). - `3-3.8` number — Number of businesses whose rating is between 3 (included) and 3.8 (excluded). - `3.8-4.3` number — Number of businesses whose rating is between 3.8 (included) and 4.3 (excluded). - `4.3-5` number — Number of businesses whose rating is between 4.3 (included) and 5. - `rank` number — Rank of the dimension compared to the others, based on the specified `order_by` parameter. **Note:** Two results with the same metrics value will have the same rank. - `rating_distribution` object - `1` number — Number of 1 star reviews. - `2` number — Number of 2 star reviews. - `3` number — Number of 3 star reviews. - `4` number — Number of 4 star reviews. - `5` number — Number of 5 star reviews. - `reply_means` object - `ai_suggestion` number — Number of reviews replied using an AI suggestion. - `auto_reply` number — Number of reviews replied using the auto reply. - `manual` number — Number of reviews replied manually (without an AI suggestion nor a reply template). - `reply_template` number — Number of reviews replied using a reply template (excluding auto replies). - `total` number — Total (ai_suggestion + auto_reply + manual + reply_template). - `reply_time` object - `fast` number — Number of reviews replied in less than 2 days - `slow` number — Number of reviews replied in more than 2 days - `not_replied` number — Number of reviews not replied - `total` number — Total (fast + slow + not_replied) - `reviews_count` number — Number of reviews - `dimension_name` string — Name of the dimension: - Business name when `dimensions` is `business` - Group name when `dimensions` is `group` - Tag name when `dimensions` is `tag` - User full name when `dimensions` is `user` - Not present in the response otherwise - `dimension_info` object — Additional info about the dimension. Only returned when `dimensions` is `business`. - `address_full` string, nullable — Full address of the business. For example : `130 Rue du Mont-Cenis`. - `city` string, nullable — The city where the business is located - `code` string — The unique store code of the business. If not provided, it will be automatically generated - `zipcode` string, nullable — Zipcode (or postal code) for the business address. Can be empty if the business' country does not require one. ## Other responses - `400` — Your request is incorrect - `401` — You are not authenticated - `403` — You are not allowed to perform this action --- [API](https://skmtc.net/partoo/apis/partoo-rest-api.md) · [All operations](https://skmtc.net/partoo/apis/partoo-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/partoo/partoo-rest-api/revisions/3652d8b1a8b3/schema)