Reviews Summary API Request

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
enum
required
Defaults to all
Allowed:
Query Params
string

Unique identifier for the merchant account.

Body Params
string

Filter for reviews with corresponding tags.

string

Filter reviews to those created on a specified UTC date / time.

string

Filter reviews to those updated on a specified UTC date / time.

string
enum
Defaults to year

Filter reviews to those created during the specified period.

Allowed:
string
enum
Defaults to year

Filter reviews to those updated during the specified period.

Allowed:
string

Defines the domain name of the web page calling the Reviews API feed.

string

Filter reviews based on the feedback id.

string

Filter for product reviews assigned to the specified parent product search code.

string
enum
Defaults to all

Filter reviews to include reviews in a status of moderation

Allowed:
string

Filter for product reviews assigned to the specified product search code.

string

Filter for reviews from a specific customer based on a unique customer reference.

string

Filter for reviews from a specific customer email.

string

Retrieve the feedback relating to a specific order.

string

Defines the number of stars or the NPS score that the reviews should have to be included in the feed.

string
enum
Defaults to include

Specified if feedback from child account should be included in the result set.

Allowed:
string
enum
Defaults to include

Specifies filters applied to feedback with associated media.

Allowed:
string
enum
Defaults to include

Specifies how product reviews with no comments should be handled.

Allowed:
string
enum
Defaults to include

Specifies the filter to be applied to unanswered feedback rated 1 or 2 stars during the first 48 hours.

Allowed:
string
enum
Defaults to exclude

Only functional if the account has Smart Themes enabled. Specifies if enhanced insight data should be included in the API response.

Allowed:
string

Only functional if the account has Smart Themes enabled and the API call includes the enhanced_insight parameter. Filter reviews to those that include the associated feature.

Responses

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here!