Sign in

v1

latestOpenAPI 3.0.12026-07-243266138.0 KB
Endpoints

Get the total number of reviews based on a filter.

This endpoint retrieves count of reviews for a specific channel The result set can be modified using a set of filters. Query parameters can be added to the request, separated by &.

get/reviews/count

Query parameters

channelsstring[]

The list of channels for which the list of reviews will be returned.

Example: channels=chl-xxxxxxxx-yyyy-xxxx-yyyy-xxxxxxxxxxx1,chl-xxxxxxxx-yyyy-xxxx-yyyy-xxxxxxxxxxx2

submittedAfterstring

submittedAfter is a timestamp in the ISO 8601 and RFC3339 compliant format yyyy-MM-dd’T’HH:mm:ss.SSSZ. Check the glossary for examples of valid datetime formats. The list of reviews will only contain reviews submitted with a later timestamp.

Example: 2018-02-01T17:10:42.733Z

submittedBeforestring

submittedBefore is a timestamp in the ISO 8601 and RFC3339 compliant format yyyy-MM-dd’T’HH:mm:ss.SSSZ. Check the glossary for examples of valid datetime formats. The list of reviews will only contain reviews submitted with an earlier timestamp.

Example: 2018-02-01T17:10:42.733Z

ratinginteger[]

A comma-separated list of star ratings to be retrieved. If not set, all reviews are listed.

Example: 1, 2, 5

statusstring[]

A comma-separated list of statuses to be retrieved. If not set, all reviews are listed.

The statuses you can filter for are:

  • APPROVED
  • MODERATION
  • REJECTED

Example: APPROVED, MODERATION

See our glossary entry for more information on review statuses.

typestring[]

A comma-separated list of review types to be retrieved. If not set, all reviews are listed.

The review types are:

  • SERVICE_REVIEW
  • PRODUCT_REVIEW

Example: PRODUCT_REVIEW

See our glossary entry for more information on review states.

hasReplyboolean

Reduces the list of reviews to only match reviews that either have been replied to or not. If not set, all reviews are listed.

Example: true

ignoreStatementsboolean

Filters the list to ignore statements. Default is true.

querystring

A full-text search query that is matched against the order reference and email properties.

skustring[]

A comma-separated list of product's SKUs. Be aware, that this parameter does only make sense for product reviews.

Headers

Authorizationstring required

An OAuth2 authorization header with an access token, see OAuth2

Response

The count of reviews for the given channel.

accountIdstring

The account ID

channelListstring[]

The ID of the channels for which the review count will be returned.

totalElementsinteger

The amount of reviews of a channel dependant of filter

Example response

{
  "accountId": "acc-xxxxxxxx-yyyy-xxxx-yyyy-xxxxxxxxxxxx"
}