Get Review metrics

curl --request GET \
  --url https://api.partoo.co/v2/review_analytics/metrics \
  --header 'x-APIKey: <api-key>'

import requests

url = "https://api.partoo.co/v2/review_analytics/metrics"

headers = {"x-APIKey": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'x-APIKey': '<api-key>'}};

fetch('https://api.partoo.co/v2/review_analytics/metrics', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.partoo.co/v2/review_analytics/metrics",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-APIKey: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.partoo.co/v2/review_analytics/metrics"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-APIKey", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.partoo.co/v2/review_analytics/metrics")
  .header("x-APIKey", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.partoo.co/v2/review_analytics/metrics")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-APIKey"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "page": 1,
  "count": 2,
  "max_page": 1,
  "data": [
    {
      "dimension": "59b2645db12ff60643ef832c",
      "dimension_name": "Business 1",
      "dimension_info": {
        "address_full": "190 rue Championnet",
        "city": "Paris",
        "zipcode": "75018",
        "code": "PTOCODE1"
      },
      "metrics": {
        "average_rating": 2.31
      }
    },
    {
      "dimension": "60b2645fb12ff60643ef8344",
      "dimension_name": "Business 2",
      "dimension_info": {
        "address_full": "190 rue Championnet",
        "city": "Paris",
        "zipcode": "75018",
        "code": "PTOCODE2"
      },
      "metrics": {
        "average_rating": 4.31
      }
    }
  ]
}

Review analytics

Get Review 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…)

GET

review_analytics

metrics

Get Review metrics

curl --request GET \
  --url https://api.partoo.co/v2/review_analytics/metrics \
  --header 'x-APIKey: <api-key>'

import requests

url = "https://api.partoo.co/v2/review_analytics/metrics"

headers = {"x-APIKey": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'x-APIKey': '<api-key>'}};

fetch('https://api.partoo.co/v2/review_analytics/metrics', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.partoo.co/v2/review_analytics/metrics",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-APIKey: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.partoo.co/v2/review_analytics/metrics"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-APIKey", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.partoo.co/v2/review_analytics/metrics")
  .header("x-APIKey", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.partoo.co/v2/review_analytics/metrics")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-APIKey"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "page": 1,
  "count": 2,
  "max_page": 1,
  "data": [
    {
      "dimension": "59b2645db12ff60643ef832c",
      "dimension_name": "Business 1",
      "dimension_info": {
        "address_full": "190 rue Championnet",
        "city": "Paris",
        "zipcode": "75018",
        "code": "PTOCODE1"
      },
      "metrics": {
        "average_rating": 2.31
      }
    },
    {
      "dimension": "60b2645fb12ff60643ef8344",
      "dimension_name": "Business 2",
      "dimension_info": {
        "address_full": "190 rue Championnet",
        "city": "Paris",
        "zipcode": "75018",
        "code": "PTOCODE2"
      },
      "metrics": {
        "average_rating": 4.31
      }
    }
  ]
}

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

metrics

enum<string>

required

List of analytics to return. At least one in that list.

Available options:

average_rating,

rating_distribution,

reviews_count,

reply_time,

reply_means,

average_rating_distribution,

rank

dimensions

enum<string>

How the returned data will be aggregated. If no dimension is given, the request will return the sum of each metric for all requested days and businesses.

Available options:

day,

week,

month,

year,

business,

group,

user,

tag

order_by

string

See above for the list of all orders available. At most one in the list.

- before a field to order_by DESC, nothing for ASC

Example:

"-average_rating"

business__in

string[]

Filter by business ids

Business id

business__notin

string[]

Filter by all allowed businesses except the ones given in business__notin

Business id

groups

integer[]

Filter by groups ids

Group id

Response

page

integer

Current page number

Example:

1

max_page

integer

Last page number

Example:

10

count

integer

Number of resources complying with filters

Example:

287

data

object[]

Show child attributes

Profile keywords for your business Global reviews statistics

⌘I