Here we'll take a closer look at the available parameters and values for the Review API endpoint that retrieves summary information such as counts and average scores (no detailed review content is included. The parameters for detailed content can be found at Reviews API Request Parameters (Reviews).
Reviews API IntroductionReviews API Response Parameters (Summary)
https://api.feefo.com/api/version/reviews/summary/
Note that in all examples on this page, version should be replaced with the appropriate version number of the API. The current version number for Reviews API can be found in API Versions.
There are four possible modes for this endpoint:
-
https://api.feefo.com/api/version/reviews/summary/all
mode = all: Creates a summary for both your service and product reviews. Authentication is not required.
-
https://api.feefo.com/api/version/reviews/summary/service
mode = service: Creates a summary of your service reviews. Authentication is not required.
-
https://api.feefo.com/api/version/reviews/summary/product
mode = product: Creates a summary of your product reviews. Authentication is not required.
-
https://api.feefo.com/api/version/reviews/summary/nps
mode = nps: Creates a summary of your NPS feedback. Authentication is required. See API Authentication for more details.
The following table lists all parameters available for the https://api.feefo.com/api/version/reviews/summary/ endpoint. Click on the parameter name for more details:
| Request parameter | Brief description | Value | Required or optional | Default | Authentication required |
|
merchant_identifier |
Unique identifier for the merchant account. | string | Required | None | No |
|
tags |
Filter for reviews with corresponding tags. | string | Optional | None | No |
|
date_time |
Filter reviews to those created on a specified UTC date / time. | string | Optional |
None |
No |
|
updated_date_time |
Filter reviews to those updated on a specified UTC date / time. | string | Optional |
None |
No |
|
since_period |
Filter reviews to those created during the specified period. | enum | Optional | year | No |
|
since_updated_period |
Filter reviews to those updated during the specified period. | enum | Optional | year | No |
| origin | Defines the domain name of the web page calling the Reviews API feed. |
string | Optional but required when using multiple domains to call the same reviews API feed |
None | No |
|
id |
Filter reviews based on the feedback id. | string | Optional |
None |
No |
|
parent_product_sku |
Filter for product reviews assigned to the specified parent product search code. | string |
Optional for: mode = all mode = service mode = nps Required for: mode = product (if product_sku is not used) |
None |
No |
|
product_sku |
Filter for product reviews assigned to the specified product search code. | string |
Optional for: mode = all mode = service mode = nps Required for: mode = product (if parent_product_sku is not used) |
None |
No |
|
customer_reference |
Filter for reviews from a specific customer based on a unique customer reference. | string | Optional |
None |
Yes |
|
customer_email |
Filter for reviews from a specific customer email. | string | Optional |
None |
Yes |
|
order_reference |
Retrieve the feedback relating to a specific order. | string | Optional |
None |
Yes |
|
rating
|
Defines the number of stars or the NPS score that the reviews should have to be included in the feed. |
string | Optional | None | No |
|
children |
Specified if feedback from child account should be included in the result set. | enum | Optional | include | No |
|
media |
Specifies filters applied to feedback with associated media. | enum | Optional | include | No |
|
empty_product_comments |
Specifies how product reviews with no comments should be handled. | enum | Optional | default | No |
|
unanswered_feedback |
Specifies the filter to be applied to unanswered feedback rated 1 or 2 stars during the first 48 hours. | enum | Optional | include | No |