Reviews API Summary Detail
Feefo Reviews Summary API: Endpoint Parameters
The following table lists all request parameters available for the Feefo Reviews Summary API endpoint (https://api.feefo.com/api/{version}/reviews/summary/), where {version} should be replaced with the current API version number. Use these parameters to filter, paginate, and authenticate requests when retrieving aggregated review summary data for a merchant account.
https://api.feefo.com/api/version/reviews/summary/ endpoint.
Can I use the Reviews Summary API to self-host review data?
Feefo's Reviews API allows you to retrieve all the review data you need to manage your own display solution. However, this endpoint is not suitable for batch retrieving review content for self-hosting due to network edge caching. If you would like to self-host your review content, please contact our team to discuss the solution that best fits your requirements.
|
Request parameter |
Brief description |
Value |
Required or optional |
Default |
|
|
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 |
Filters reviews to those created on or after a specified UTC date and time. Accepts a UTC date/time string in ISO 8601 format (e.g., yyyy-MM-ddTHH:mm:ssZ). |
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. |
Optional |
year |
No |
|
|
since_updated_ period |
Filter reviews to those updated during the specified period. |
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: |
None |
No |
|
|
Filter reviews to include reviews in a status of moderation |
Optional |
year |
Yes |
|
|
product_sku |
Filter for product reviews assigned to the specified product search code. |
string |
Optional for: |
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. |
Optional |
include |
No |
|
|
media |
Specifies filters applied to feedback with associated media. |
Optional |
include |
No |
|
|
empty_product_ comments |
Specifies how product reviews with no comments should be handled. |
Optional |
default |
No |
|
|
Unanswered_feedback |
Specifies the filter to be applied to unanswered feedback rated 1 or 2 stars during the first 48 hours. |
Optional |
include |
No |
|
|
enhanced_insight |
Only functional if the account has Smart Themes enabled. |
Optional |
exclude |
No |
|
|
feature |
Only functional if the account has Smart Themes enabled and the API call includes the enhanced_insight parameter. | ||||
mode | Specifies the type of reviews to retrieve. | Optional | all | No | |
|
string |
Optional for: |
None |
No |