Qualitative evolution

GET 
/api/v2/reviews/analytics/qualitative

This endpoint lets you view the qualitative evolution of the reviews rating for all of your businesses subscribed to Review Management. The API returns the reviews average rating by bucket (time range).

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

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
bucket string

Possible values: [day, week, month, year]

Default value: week

Defining the time range of a data bucket.

This will determine the precision of the returned data. For example, if you choose 'day', you will receive the number of reviews for each day.

cumulative boolean

Default value: true

If cumulative = false, return the average rating of reviews from the current bucket only.

If cumulative = true, return the average rating of reviews from all the buckets until the current one (included). The cumulative representation show the evolution of the average rating over time.

Responses

200

application/json

Schema

Schema

• Array [

date datenullable

Start date of the bucket

average numbernullable

Average rating

added numbernullable

Number of reviews added during the current bucket.

cum_sum numbernullable

Cumulative sum of the number of reviews.

• ]

Example (from schema)

[
  {
    "date": "2020-07-27",
    "average": 4.5,
    "added": 10,
    "cum_sum": 100
  }
]

400

application/json

Schema

Schema

statusCode integerrequired

HTTP status code

message string

Error message

error string

Error name

Example (from schema)

{
  "statusCode": 404,
  "message": "Cannot find item",
  "error": "Not Found"
}

401

application/json

Schema

Schema

statusCode integerrequired

HTTP status code

message string

Error message

error string

Error name

Example (from schema)

{
  "statusCode": 404,
  "message": "Cannot find item",
  "error": "Not Found"
}

403

application/json

Schema

Schema

statusCode integerrequired

HTTP status code

message string

Error message

error string

Error name

Example (from schema)

{
  "statusCode": 404,
  "message": "Cannot find item",
  "error": "Not Found"
}

404

application/json

Schema

Schema

statusCode integerrequired

HTTP status code

message string

Error message

error string

Error name

Example (from schema)

{
  "statusCode": 404,
  "message": "Cannot find item",
  "error": "Not Found"
}

422

application/json

Schema

Schema

statusCode integerrequired

HTTP status code

message string

Error message

location stringrequired

Possible values: [query, body, response, param]

Where in the request the error occurred

errors

object[]

required

Array [

path stringrequired

Possible values: non-empty

Path to the property with the error

constraints

object

required

property name* string

Error message

]

Example (from schema)

{
  "statusCode": 404,
  "message": "Cannot find item",
  "location": "query",
  "errors": [
    {
      "path": "business.id",
      "constraints": {
        "object_required_property": "Required property"
      }
    }
  ]
}

500

application/json

Schema

Schema

statusCode integerrequired

HTTP status code

message string

Error message

error string

Error name

Example (from schema)

{
  "statusCode": 404,
  "message": "Cannot find item",
  "error": "Not Found"
}

Loading...