API Documentation
eTrusted Control Centre

Get the total number of reviews based on a filter.

get
https://api.etrusted.com/reviews/count

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 &.

Query Params
channels
array of strings

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

channels
string

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

string

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

rating
array of integers
length between 1 and 5

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

Example: 1, 2, 5

rating
status
array of strings

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.

status
type
array of strings

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.

type
boolean

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

boolean

Filters the list to ignore statements.
Default is true.

string

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

sku
array of strings

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

sku
Headers
string
required

An OAuth2 authorization header with an access token, see OAuth2

Responses

401

Unauthorized

403

Forbidden

404

Not found

Updated over 1 year ago

Language
LoadingLoading…
Response
Choose an example:
application/json

Updated over 1 year ago