Get all products reviews

The method retrieves all the reviews that you have received on all your products by passing organization ID. The response includes organization and product information along with the details of review and reviewer. Paginating the results is possible with results per page option. Sorting can be performed on Reviewer Name, Review Rating and Review created in the order of Ascending or Descending. Reviews can also be filtered based on the Review Status(AWAITING_ACTIVATION, APPROVED, PENDING, REJECTED), product whose title matches the provided keywords, Rating greater than, Rating less than, Reviews after date and Reviews before date.

HTTP method: GET
Authentication: Public_key::Private_key
URL: https://api.trustytribe.com/review/{organization_id}

Curl Request :


curl -X GET --header 'Accept: application/json' --header 'Authorization: Public_key::Private_key' 'https://api.trustytribe.com/review/{organization_id}'
            
<> Parameters
productId | Optional String

The id of the product whose reviews are to be fetched.

Example: https://api.trustytribe.com/review/123?productId=456


page | Optional Integer

The page to retrieve. If the page number requested is higher than the available number of pages an empty array will be returned.

Example: ?page=2


perPage | Optional Integer

The number of results to be retrieved per page.

DefaultValue: 10

Example: ?perPage=3


sortBy | Optional String

To sort the results in ascending or descending format.

Options: ASC, DESC

Constraints: sortBy and sortOn should be used together.

Example: ?sortBy=ASC&sortOn=user.name


sortOn | Optional String

To apply sort to the results that are to be retrieved.

Options: user.name, review.rating, userWroteReview.created_at

Constraints: sortBy and sortOn should be used together

Example: ?sortBy=DESC&sortOn=userWroteReview.created_at


reviewStatus | Optional String

To retrieve reviews according to the status of the review.

Options: AWAITING_ACTIVATION, APPROVED, PENDING, REJECTED

Example: ?reviewStatus=APPROVED


productKeyword | Optional String

To retrieve reviews of the product whose title matches the provided keywords.

Example: ?productKeyword=Test


startReview | Optional Double

To retrieve reviews of the product whose ratings are greater than or equal to the number passed.

Constraints: The allowed range is minimum: 1.0, maximum: 5.0

Example: ?startReview=2


endReview | Optional Double

To retrieve reviews of the product whose ratings are less than or equal to the number passed.

Constraints: The allowed range is minimum: 1.0, maximum: 5.0

Example: ?endReview=4.5


reviews_after | Optional String

To retrieve reviews created after the mentioned date.

Constraints: The string should be timestamp in miliseconds

Example: ?reviews_after=1519731239


reviews_before | Optional String

To retrieve reviews created before the mentioned date.

Constraints: The string should be timestamp in miliseconds

Example: ?reviews_before=1519731239


Response
{
"meta": {
  "count": 10,
  "pageCount": 33,
  "totalCount": 321,
  "next": "https://api.trustytribe.com/review/666?page=2&perPage=10",
  "previous": null,
  "self": "https://api.trustytribe.com/review/666?page=1&perPage=10",
  "first": "https://api.trustytribe.com/review/666?page=1&perPage=10",
  "last": "https://api.trustytribe.com/review/666?page=33&perPage=10"
},
"results": [
  {
    "product": {
      "image": "",
      "unique_id": "34858",
      "updated_at": 1519635496507,
      "created_at": 1519635496507,
      "title": "Test Profile",
      "url": "http://example.com/profile/test",
      "id": 1114
    },
    "organization": {
      "zip": "NE17",
      "country": "GB",
      "website": "https://example.com",
      "unique_id": "ee8e35f7-78fd-4b89-8992-f92eccd47634",
      "paid_status": "PAID",
      "address": "",
      "description": "",
      "domains": "[https://www.example.com, https://example.com, https://beta.example.com, http://web.example.com]",
      "title": "Example",
      "sandbox_public_key": "sandbox_pub_266219b93179eb6c17a6",
      "updated_at": 1515057668459,
      "live_public_key": "live_pub_eyJ1aWQiOjIsInBlcm1pc3Npb58iIjpbjTvydXN0eVdlYkFwcENsaWVudCJdLCJpYXQiOjE1MDk0MzAzMDd9",
      "sandbox_private_key": "sandbox_pri_41fa0b39ai89b6e5207f",
      "live_private_key": "live_pri_vZ2DQCK_3t3KiFOGst89YuYQp44QNWGs0IKXm_DcTLg",
      "photo_url": "",
      "customer_id": "cus_C4eCOL09tlb6Ko",
      "plan": "lite",
      "email": "[email protected]",
      "slug": "example.com",
      "id": 666
    },
    "review": {
      "updated_at": 1519635496638,
      "rating": 5,
      "editor_panel": false,
      "description": "Test review1",
      "created_at": 1519635496638,
      "title": "Test review1",
      "status": "PENDING",
      "id": 1115
    },
    "userWroteReview": {
      "start": 1113,
      "end": 1115,
      "type": "WROTE",
      "properties": {
        "user_email": "[email protected]",
        "user_type": "NORMAL_USER",
        "updated_at": 1519635496545,
        "created_at": 1519635496545
      },
      "id": 1456
    },
    "user": {
      "emails": [
        "[email protected]"
      ],
      "website": "",
      "activation_code": "005f01ff1e79aab0afb7",
      "organization": "",
      "name": "Test",
      "created_at": 1519635496316,
      "domains": [],
      "primary_email": "[email protected]",
      "photo_url": [
        ""
      ],
      "status": "PENDING",
      "id": 1113
    },
    "reviewRank": 0
  },
],
}