Skip to main content
GET
/
review_analytics
/
metrics
Get Review metrics
curl --request GET \
  --url https://api.partoo.co/v2/review_analytics/metrics \
  --header 'x-APIKey: <api-key>'
{
  "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

Business id

​
tags
integer[]

Restrict the data returned on reviews that have been assigned the specified tags.

Tag id

​
update_date__gte
string<datetime>

Restrict the data returned on reviews which update_date are after the given date.

​
update_date__lte
string<datetime>

Restrict the data returned on reviews which update_date are before the given date.

​
page
integer
default:1

The page number you want to request.

Required range: x >= 1
​
per_page
integer
default:30

The maximum number of result items to return in a page.

Response

OK

​
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[]