List Reviews

List reviews of any store by store domain/url.

As a partner you have access to list any reviews that a Fera store is using.

Normally this information is available via our public api (Fera.js) but that requires you to know the store's public key.

This API returns data in the same format as the public API (Fera.js) but only requires the store domain/url.

List all Reviews

This list of reviews includes all reviews for all products, plus store (business) reviews that aren't specific to a product.

List All Product Reviews

Retrieve a list of product reviews. That is, retrieve all reviews that are about products.

get

/stores/products/reviews

Authorizations

Query parameters

domainstringrequired

Domain, URL, public key or Fera ID of the shop/store.

Example: example.myshopify.com

pageinteger · int32 · min: 1

Current page number, if pagination used.

page_sizeinteger · int32 · min: 1

Number of items per page.

limitinteger · int32 · min: 1 · max: 100

Maximum number of items retrieved.

offsetinteger · int32

Starting position of items request query.

product.idstring

Filter by Fera product ID or external product ID.

Example: fpro_123abc

product.idsstring

Filter by multiple Fera product IDs or external product IDs. Comma-separated list or array of fields accepted.

Example: fpro_1abc,fpro_2def

customer_idstring

Filter by Fera customer ID or external customer ID.

Example: fcus_12ab

order.idstring

Filter by Fera order ID or external order ID.

Example: ford_123

subjectstring · enum

Filter by what the resource is describing; A specific product, the entire store (ie overall experience) or both (all). Default: both.

Example: product

Options: both, product, store

verifiedboolean

Only show content submitted by verified sources (or unverified sources).

customer.emailstring · email

Filter by customer email

sort_bystring · enum

Sort (order) the response results by the given attribute.

Add :desc to sort in descending order, or :asc to sort in ascending order.

For example: created_at:desc would get you created_at in descending order.

Options: created_at

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.fera.ai/v3/partners/stores/products/reviews?domain=text'

200

400

200

{
  "meta": {
    "page": 1,
    "page_size": 10,
    "page_count": 3,
    "limit": 10,
    "offset": 0,
    "total_count": 123
  },
  "data": [
    {
      "id": "fRev_12ab",
      "is_verified": true,
      "is_test": false,
      "external_product_id": "12345678",
      "product_id": "fpro_12ab",
      "external_customer_id": "12345678",
      "customer_id": "fcus_12ab",
      "created_at": "2022-11-06T19:38:13.116Z",
      "updated_at": "2022-11-06T19:38:13.117Z",
      "rating": 4,
      "heading": "This is a great product!",
      "body": "This is a great product! I love it!",
      "product": {
        "id": "fPro_12ab",
        "external_id": "12345678",
        "name": "Red Sneakers",
        "sku": "RS-123",
        "url": "https://www.example.com/red-sneakers",
        "thumbnail_url": "https://cdn.fera.ai/img/sunglasses.png",
        "price": 10,
        "created_at": "2022-11-06T19:38:14.101Z",
        "updated_at": "2022-11-06T19:38:14.101Z",
        "rating": 5,
        "counts": {
          "reviews": 5,
          "media": 3,
          "photos": 2,
          "videos": 1
        }
      },
      "customer": {
        "id": "fSer_12ab",
        "display_name": "George B.",
        "display_location": "Austin, TX",
        "avatar_url": "https://cdn.fera.ai/img/shoppers/placeholder.png",
        "average_rating": 4.5,
        "rating": 0,
        "counts": {
          "reviews": 5,
          "media": 5
        }
      },
      "state": "pending",
      "subject": "product",
      "media": [
        {
          "id": "fMed_12ab",
          "is_verified": true,
          "is_test": false,
          "external_product_id": "12345678",
          "product_id": "fpro_12ab",
          "external_customer_id": "12345678",
          "customer_id": "fcus_12ab",
          "created_at": "2022-11-06T19:38:13.669Z",
          "updated_at": "2022-11-06T19:38:13.669Z",
          "type": "photo",
          "review_id": "frev_12ab",
          "url": "https://cdn.fera.ai/img/sunglasses.png",
          "thumbnail_url": "https://cdn.fera.ai/img/sunglasses.png?size=thumbnail",
          "caption": "Here's how my product purchase looked when I opened the box I received.",
          "state": "pending",
          "subject": "product"
        }
      ],
      "store_reply": {
        "body": "We're sorry that it took so long for your product to arrive but we are delighted that you loved the product we shipped you and recommend it to others! Thanks for being a great customer!",
        "created_at": "2025-02-22T08:51:16.830Z"
      },
      "counts": {
        "media": 3,
        "photos": 2,
        "videos": 1
      }
    }
  ]
}

Successful response

Code Examples

CURL

curl --request GET \
     --url https://api.fera.ai/v3/partners/stores/products/reviews?domain=example.com \
     --header 'Api-Key: YOUR_PARTNER_API_KEY'
# See JSON response examples above

List a Specific Product's Reviews

List Product Reviews

Retrieve a list of reviews that belong to a product, if any.

get

/stores/products/{id}/reviews

Authorizations

Path parameters

idstringrequired

ID of the product you want to retrieve

Example: fpro_12ab

Query parameters

domainstringrequired

Domain, URL, public key or Fera ID of the shop/store.

Example: example.myshopify.com

pageinteger · int32 · min: 1

Current page number, if pagination used.

page_sizeinteger · int32 · min: 1

Number of items per page.

limitinteger · int32 · min: 1 · max: 100

Maximum number of items retrieved.

offsetinteger · int32

Starting position of items request query.

product.idstring

Filter by Fera product ID or external product ID.

Example: fpro_123abc

product.idsstring

Filter by multiple Fera product IDs or external product IDs. Comma-separated list or array of fields accepted.

Example: fpro_1abc,fpro_2def

customer_idstring

Filter by Fera customer ID or external customer ID.

Example: fcus_12ab

order.idstring

Filter by Fera order ID or external order ID.

Example: ford_123

subjectstring · enum

Filter by what the resource is describing; A specific product, the entire store (ie overall experience) or both (all). Default: both.

Example: product

Options: both, product, store

verifiedboolean

Only show content submitted by verified sources (or unverified sources).

customer.emailstring · email

Filter by customer email

sort_bystring · enum

Sort (order) the response results by the given attribute.

Add :desc to sort in descending order, or :asc to sort in ascending order.

For example: created_at:desc would get you created_at in descending order.

Options: created_at

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.fera.ai/v3/partners/stores/products/{id}/reviews?domain=text'

200

404

200

{
  "meta": {
    "page": 1,
    "page_size": 10,
    "page_count": 3,
    "limit": 10,
    "offset": 0,
    "total_count": 123
  },
  "data": [
    {
      "id": "fRev_12ab",
      "is_verified": true,
      "is_test": false,
      "external_product_id": "12345678",
      "product_id": "fpro_12ab",
      "external_customer_id": "12345678",
      "customer_id": "fcus_12ab",
      "created_at": "2022-11-06T19:38:13.663Z",
      "updated_at": "2022-11-06T19:38:13.664Z",
      "rating": 4,
      "heading": "This is a great product!",
      "body": "This is a great product! I love it!",
      "state": "pending",
      "subject": "product",
      "store_reply": {
        "body": "We're sorry that it took so long for your product to arrive but we are delighted that you loved the product we shipped you and recommend it to others! Thanks for being a great customer!",
        "created_at": "2025-02-22T08:51:16.830Z"
      },
      "counts": {
        "media": 3,
        "photos": 2,
        "videos": 1
      }
    }
  ]
}

Successful response

Code Examples

CURL

curl --request GET \
     --url https://api.fera.ai/v3/partners/stores/products/123456789/reviews?domain=example.com \
     --header 'Api-Key: YOUR_PARTNER_API_KEY'
# See JSON response examples above

If the store does not exist in Fera then you will receive a Bad Request response (400 status code).