{"openapi":"3.1.0","x-tagGroups":[{"name":"User-Generated Content","tags":["Reviews","Review Channels","Photos \u0026 Videos","Ratings"]},{"name":"Store Data","tags":["Products","Customers","Orders"]},{"name":"Settings","tags":["Store","Webhooks"]}],"tags":[{"name":"Reviews","description":"Customer reviews (testimonials, etc) about products and the store (overall experience)."},{"name":"Photos \u0026 Videos","description":"Customer photos and videos (media) of products or the store (overall experience)."},{"name":"Ratings","description":"Aggregate rating objects that store the average rating of a product or the store as well as the total rating/review counts."},{"name":"Customers","description":"Customers that are either existing reviewers or future potential reviewers.\n\nThis model supports access by external ID or Fera ID. That is, you can use `/customers/1234` assuming the customer's ID\nin your external system (usually Shopify, Wix or the eCommerce platform) is `1234`."},{"name":"Products","description":"Products sold in the store.\n\nThis data is mostly used by Fera to link reviews to product pages and display information about the product(s) reviewed.\n\nThis model supports access by external ID or Fera ID. That is, you can use `/products/1234` assuming the product's ID in\nyour external system (usually Shopify, Wix or the eCommerce platform) is `1234`."},{"name":"Store","description":"Fera store (account) data. This is the center point of all data."},{"name":"Webhooks","description":"Create and manage custom webhooks to react to events that occur in Fera in your system(s).\n### Partner app webhooks managed separately.\nFera will automatically track and separate webhooks created by apps from the ones created by the store owner/account from the\n[webhooks section in the app](https://app.fera.ai/integrations/webhooks).\n\n**Webhooks created by apps won't be visible in the store account's webhooks section.**\n\n### Webhooks created by apps removed upon uninstallation of app\nWhen a store owner/account uninstalls a partner app Fera will automatically also uninstall any webhooks created through this endpoint by the app.\n\n### Only recommended for partner apps\nThis endpoint is mostly useful for Fera partners and app developers.\n\nFor store owners and people customizing a specific account, you should manage your webhooks from the\n[webhooks section in the app](https://app.fera.ai/integrations/webhooks) instead for greater convenience.\n\n[Learn more about Fera webhooks here](https://developers.fera.ai/docs/webhook-introduction).\n\n### Webhook Security\nWebhooks `POST` requests are made with a `jwt` URL parameter which is encrypted using HS256 (HMAC SHA256) and either your store's secret\nAPI key (for store/account webhooks) OR your app's secret key/client secret (for app webhooks).\n"},{"name":"Orders","description":"Orders or invoices placed in the store/business that Fera should know about.\n\nThese are used to trigger review requests and track whether customers have reviewed their orders.\n\nThis model supports access by external ID or Fera ID. That is, you can use `/orders/1234` assuming the order's ID in your external system (usually Shopify, Wix or the eCommerce platform) is `1234`."},{"name":"Users","description":"Users are people who manage the store/business account in Fera. **These are not customers**.\n\nUsers can manage multiple stores (accounts) in Fera."}],"paths":{"/reviews/{id}":{"get":{"summary":"Retrieve Review","description":"Retrieve data for a specific review.","operationId":"retrieve-review","security":[{"apiKey":[]},{"oauth2":["read"]}],"tags":["Reviews"],"parameters":[{"name":"id","in":"path","description":"Fera  ID of the review","required":true,"example":"frev_12ab","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Review"}}}},"404":{"$ref":"#/components/responses/NotFoundError"}}}},"/reviews":{"get":{"summary":"List Reviews","description":"Retrieve a list of reviews.","operationId":"list-reviews","security":[{"apiKey":[]},{"oauth2":["read"]}],"tags":["Reviews"],"parameters":[{"$ref":"#/components/parameters/pageRequestQueryParam"},{"$ref":"#/components/parameters/perPageRequestQueryParam"},{"$ref":"#/components/parameters/limitRequestQueryParam"},{"$ref":"#/components/parameters/offsetRequestQueryParam"},{"description":"Filter by Fera product ID or external product ID.","example":"fpro_123abc","name":"product.id","in":"query","schema":{"type":"string"}},{"in":"query","description":"Filter by multiple Fera product IDs or external product IDs. Comma-separated list or array of fields accepted.","example":"fpro_1abc,fpro_2def","name":"product.ids","schema":{"type":"string"}},{"in":"query","description":"Filter by Fera customer ID or external customer ID.","schema":{"type":"string"},"example":"fcus_12ab","name":"customer_id"},{"in":"query","description":"Filter by what the resource is describing; A specific product, the entire store (ie overall experience) or both (all). Default: both.","schema":{"type":"string","enum":["both","product","store"]},"example":"product","name":"subject"},{"allowEmptyValue":true,"in":"query","description":"Only show content submitted by verified sources (or unverified sources).","schema":{"type":"boolean"},"name":"verified"},{"description":"Search for customer reviews by rating.","example":"2;4","name":"rating","in":"query","schema":{"type":"string"}},{"example":"true","description":"Only show reviews with any textual content (summary or body).","name":"only_with_content","in":"query","schema":{"type":"string"}},{"name":"sort_by","in":"query","required":false,"description":"Sort (order) the response results by the given attribute.\n\nAdd `:desc` to sort in descending order, or `:asc` to sort in ascending order.\n\nFor example: created_at:desc would get you created_at in descending order.","schema":{"type":"string","enum":["created_at"]}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Review"}},"meta":{"$ref":"#/components/schemas/listMetaParam"}}}}}},"400":{"$ref":"#/components/responses/BadRequestError"}}}},"/media":{"get":{"summary":"List Photos \u0026 Videos","description":"Retrieve a list of media.","operationId":"list-media","security":[{"apiKey":[]},{"oauth2":["read"]}],"tags":["Photos \u0026 Videos"],"parameters":[{"$ref":"#/components/parameters/pageRequestQueryParam"},{"$ref":"#/components/parameters/perPageRequestQueryParam"},{"$ref":"#/components/parameters/limitRequestQueryParam"},{"$ref":"#/components/parameters/offsetRequestQueryParam"},{"description":"Filter by Fera product ID or external product ID.","example":"fpro_123abc","name":"product.id","in":"query","schema":{"type":"string"}},{"in":"query","description":"Filter by multiple Fera product IDs or external product IDs. Comma-separated list or array of fields accepted.","example":"fpro_1abc,fpro_2def","name":"product.ids","schema":{"type":"string"}},{"in":"query","description":"Filter by Fera customer ID or external customer ID.","schema":{"type":"string"},"example":"fcus_12ab","name":"customer_id"},{"example":"ford_123","description":"Filter by Fera order ID or external order ID.","name":"order.id","in":"query","schema":{"type":"string"}},{"in":"query","description":"Filter by what the resource is describing; A specific product, the entire store (ie overall experience) or both (all). Default: both.","schema":{"type":"string","enum":["both","product","store"]},"example":"product","name":"subject"},{"allowEmptyValue":true,"in":"query","description":"Only show content submitted by verified sources (or unverified sources).","schema":{"type":"boolean"},"name":"verified"},{"example":"photo","description":"Type of media: `photo` or `video`.\n\n  Can also be used to filter the subject at the same time. For example: `product_photo`.","name":"type","in":"query","schema":{"type":"string"}},{"description":"Review that the media is a part of (submitted along with).","example":"frev_123abc","name":"review.id","in":"query","schema":{"type":"string"}},{"name":"sort_by","in":"query","required":false,"description":"Sort (order) the response results by the given attribute.\n\nAdd `:desc` to sort in descending order, or `:asc` to sort in ascending order.\n\nFor example: created_at:desc would get you created_at in descending order.","schema":{"type":"string","enum":["created_at"]}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Media"}},"meta":{"$ref":"#/components/schemas/listMetaParam"}}}}}},"400":{"$ref":"#/components/responses/BadRequestError"}}}},"/media/{id}":{"get":{"summary":"Retrieve Photo or Video","description":"Retrieve data for a specific media.","operationId":"retrieve-media","security":[{"apiKey":[]},{"oauth2":["read"]}],"tags":["Photos \u0026 Videos"],"parameters":[{"name":"id","in":"path","description":"Fera  ID of the media","required":true,"example":"fmed_12ab","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Media"}}}},"404":{"$ref":"#/components/responses/NotFoundError"}}}},"/products/ratings":{"get":{"summary":"List All Product Aggregate Ratings","description":"Retrieve a list of product ratings.","operationId":"list-product-ratings","security":[{"apiKey":[]},{"oauth2":["read"]}],"tags":["Ratings","Products"],"parameters":[{"$ref":"#/components/parameters/pageRequestQueryParam"},{"$ref":"#/components/parameters/perPageRequestQueryParam"},{"$ref":"#/components/parameters/limitRequestQueryParam"},{"$ref":"#/components/parameters/offsetRequestQueryParam"},{"in":"query","description":"Filter by what the resource is describing; A specific product, the entire store (ie overall experience) or both (all). Default: both.","schema":{"type":"string","enum":["both","product","store"]},"example":"product","name":"subject"},{"example":"12345678","description":"External product ID (usually the Wix, Shopify or other eCommerce platform product ID).","name":"external_id","in":"query","schema":{"type":"string"}},{"example":"12345678,87654321","description":"Comma-separated list of external product IDs (usually the Wix, Shopify or other eCommerce platform product IDs).","name":"external_ids","in":"query","schema":{"type":"string"}},{"name":"sort_by","in":"query","required":false,"description":"Sort (order) the response results by the given attribute.\n\nAdd `:desc` to sort in descending order, or `:asc` to sort in ascending order.\n\nFor example: count:desc would get you count in descending order.","schema":{"type":"string","enum":["count","average"]}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Rating"}},"meta":{"$ref":"#/components/schemas/listMetaParam"}}}}}},"400":{"$ref":"#/components/responses/BadRequestError"}}}},"/products/reviews":{"get":{"summary":"List All Product Reviews","description":"Retrieve a list of product reviews. That is, retrieve all reviews that are about products.","operationId":"list-products-reviews","security":[{"apiKey":[]},{"oauth2":["read"]}],"tags":["Products","Reviews"],"parameters":[{"$ref":"#/components/parameters/pageRequestQueryParam"},{"$ref":"#/components/parameters/perPageRequestQueryParam"},{"$ref":"#/components/parameters/limitRequestQueryParam"},{"$ref":"#/components/parameters/offsetRequestQueryParam"},{"description":"Filter by Fera product ID or external product ID.","example":"fpro_123abc","name":"product.id","in":"query","schema":{"type":"string"}},{"in":"query","description":"Filter by multiple Fera product IDs or external product IDs. Comma-separated list or array of fields accepted.","example":"fpro_1abc,fpro_2def","name":"product.ids","schema":{"type":"string"}},{"in":"query","description":"Filter by Fera customer ID or external customer ID.","schema":{"type":"string"},"example":"fcus_12ab","name":"customer_id"},{"in":"query","description":"Filter by what the resource is describing; A specific product, the entire store (ie overall experience) or both (all). Default: both.","schema":{"type":"string","enum":["both","product","store"]},"example":"product","name":"subject"},{"allowEmptyValue":true,"in":"query","description":"Only show content submitted by verified sources (or unverified sources).","schema":{"type":"boolean"},"name":"verified"},{"description":"Search for customer reviews by rating.","example":"2;4","name":"rating","in":"query","schema":{"type":"string"}},{"example":"true","description":"Only show reviews with any textual content (summary or body).","name":"only_with_content","in":"query","schema":{"type":"string"}},{"name":"sort_by","in":"query","required":false,"description":"Sort (order) the response results by the given attribute.\n\nAdd `:desc` to sort in descending order, or `:asc` to sort in ascending order.\n\nFor example: created_at:desc would get you created_at in descending order.","schema":{"type":"string","enum":["created_at"]}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Review"}},"meta":{"$ref":"#/components/schemas/listMetaParam"}}}}}},"400":{"$ref":"#/components/responses/BadRequestError"}}}},"/products/media":{"get":{"summary":"List All Product Photos \u0026 Videos","description":"Retrieve a list of all photos and videos submitted by customers that are about a product.","operationId":"list-products-media","security":[{"apiKey":[]},{"oauth2":["read"]}],"tags":["Products","Photos \u0026 Videos"],"parameters":[{"$ref":"#/components/parameters/pageRequestQueryParam"},{"$ref":"#/components/parameters/perPageRequestQueryParam"},{"$ref":"#/components/parameters/limitRequestQueryParam"},{"$ref":"#/components/parameters/offsetRequestQueryParam"},{"description":"Filter by Fera product ID or external product ID.","example":"fpro_123abc","name":"product.id","in":"query","schema":{"type":"string"}},{"in":"query","description":"Filter by multiple Fera product IDs or external product IDs. Comma-separated list or array of fields accepted.","example":"fpro_1abc,fpro_2def","name":"product.ids","schema":{"type":"string"}},{"in":"query","description":"Filter by Fera customer ID or external customer ID.","schema":{"type":"string"},"example":"fcus_12ab","name":"customer_id"},{"example":"ford_123","description":"Filter by Fera order ID or external order ID.","name":"order.id","in":"query","schema":{"type":"string"}},{"in":"query","description":"Filter by what the resource is describing; A specific product, the entire store (ie overall experience) or both (all). Default: both.","schema":{"type":"string","enum":["both","product","store"]},"example":"product","name":"subject"},{"allowEmptyValue":true,"in":"query","description":"Only show content submitted by verified sources (or unverified sources).","schema":{"type":"boolean"},"name":"verified"},{"example":"photo","description":"Type of media: `photo` or `video`.\n\n  Can also be used to filter the subject at the same time. For example: `product_photo`.","name":"type","in":"query","schema":{"type":"string"}},{"description":"Review that the media is a part of (submitted along with).","example":"frev_123abc","name":"review.id","in":"query","schema":{"type":"string"}},{"name":"sort_by","in":"query","required":false,"description":"Sort (order) the response results by the given attribute.\n\nAdd `:desc` to sort in descending order, or `:asc` to sort in ascending order.\n\nFor example: created_at:desc would get you created_at in descending order.","schema":{"type":"string","enum":["created_at"]}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Media"}},"meta":{"$ref":"#/components/schemas/listMetaParam"}}}}}},"400":{"$ref":"#/components/responses/BadRequestError"}}}},"/products/{id}/rating":{"get":{"summary":"Retrieve Product Aggregate Rating","description":"Retrieve a specific product's aggregate rating information (average rating and rating/review count).","operationId":"retrieve-product-rating","security":[{"apiKey":[]},{"oauth2":["read"]}],"tags":["Ratings","Products"],"parameters":[{"name":"id","in":"path","description":"Fera or external ID of the product.","required":true,"example":"fpro_12ab or 123456789","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Rating"}}}},"404":{"$ref":"#/components/responses/NotFoundError"}}}},"/products/{id}/reviews":{"get":{"summary":"List Product Reviews","description":"Retrieve a list of reviews that belong to a product, if any.","operationId":"list-product-reviews","security":[{"apiKey":[]},{"oauth2":["read"]}],"tags":["Products","Reviews"],"parameters":[{"name":"id","in":"path","description":"Fera  or external ID of the product","required":true,"example":"fpro_12ab or 123456789","schema":{"type":"string"}},{"$ref":"#/components/parameters/pageRequestQueryParam"},{"$ref":"#/components/parameters/perPageRequestQueryParam"},{"$ref":"#/components/parameters/limitRequestQueryParam"},{"$ref":"#/components/parameters/offsetRequestQueryParam"},{"description":"Filter by Fera product ID or external product ID.","example":"fpro_123abc","name":"product.id","in":"query","schema":{"type":"string"}},{"in":"query","description":"Filter by multiple Fera product IDs or external product IDs. Comma-separated list or array of fields accepted.","example":"fpro_1abc,fpro_2def","name":"product.ids","schema":{"type":"string"}},{"in":"query","description":"Filter by Fera customer ID or external customer ID.","schema":{"type":"string"},"example":"fcus_12ab","name":"customer_id"},{"in":"query","description":"Filter by what the resource is describing; A specific product, the entire store (ie overall experience) or both (all). Default: both.","schema":{"type":"string","enum":["both","product","store"]},"example":"product","name":"subject"},{"allowEmptyValue":true,"in":"query","description":"Only show content submitted by verified sources (or unverified sources).","schema":{"type":"boolean"},"name":"verified"},{"description":"Search for customer reviews by rating.","example":"2;4","name":"rating","in":"query","schema":{"type":"string"}},{"example":"true","description":"Only show reviews with any textual content (summary or body).","name":"only_with_content","in":"query","schema":{"type":"string"}},{"name":"sort_by","in":"query","required":false,"description":"Sort (order) the response results by the given attribute.\n\nAdd `:desc` to sort in descending order, or `:asc` to sort in ascending order.\n\nFor example: created_at:desc would get you created_at in descending order.","schema":{"type":"string","enum":["created_at"]}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ReviewWithoutNesting"}},"meta":{"$ref":"#/components/schemas/listMetaParam"}}}}}},"404":{"$ref":"#/components/responses/NotFoundError"}}}},"/products/{id}/media":{"get":{"summary":"List Product Photos \u0026 Videos","description":"Retrieve a list of media that belong to a product, if any.","operationId":"list-product-media","security":[{"apiKey":[]},{"oauth2":["read"]}],"tags":["Products","Photos \u0026 Videos"],"parameters":[{"name":"id","in":"path","description":"Fera  or external ID of the product","required":true,"example":"fpro_12ab or 123456789","schema":{"type":"string"}},{"$ref":"#/components/parameters/pageRequestQueryParam"},{"$ref":"#/components/parameters/perPageRequestQueryParam"},{"$ref":"#/components/parameters/limitRequestQueryParam"},{"$ref":"#/components/parameters/offsetRequestQueryParam"},{"description":"Filter by Fera product ID or external product ID.","example":"fpro_123abc","name":"product.id","in":"query","schema":{"type":"string"}},{"in":"query","description":"Filter by multiple Fera product IDs or external product IDs. Comma-separated list or array of fields accepted.","example":"fpro_1abc,fpro_2def","name":"product.ids","schema":{"type":"string"}},{"in":"query","description":"Filter by Fera customer ID or external customer ID.","schema":{"type":"string"},"example":"fcus_12ab","name":"customer_id"},{"example":"ford_123","description":"Filter by Fera order ID or external order ID.","name":"order.id","in":"query","schema":{"type":"string"}},{"in":"query","description":"Filter by what the resource is describing; A specific product, the entire store (ie overall experience) or both (all). Default: both.","schema":{"type":"string","enum":["both","product","store"]},"example":"product","name":"subject"},{"allowEmptyValue":true,"in":"query","description":"Only show content submitted by verified sources (or unverified sources).","schema":{"type":"boolean"},"name":"verified"},{"example":"photo","description":"Type of media: `photo` or `video`.\n\n  Can also be used to filter the subject at the same time. For example: `product_photo`.","name":"type","in":"query","schema":{"type":"string"}},{"description":"Review that the media is a part of (submitted along with).","example":"frev_123abc","name":"review.id","in":"query","schema":{"type":"string"}},{"name":"sort_by","in":"query","required":false,"description":"Sort (order) the response results by the given attribute.\n\nAdd `:desc` to sort in descending order, or `:asc` to sort in ascending order.\n\nFor example: created_at:desc would get you created_at in descending order.","schema":{"type":"string","enum":["created_at"]}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/MediaWithoutNesting"}},"meta":{"$ref":"#/components/schemas/listMetaParam"}}}}}},"404":{"$ref":"#/components/responses/NotFoundError"}}}},"/store":{"get":{"summary":"Retrieve Store Settings","description":"Retrieve store (account) settings.","operationId":"retrieve-store","security":[{"apiKey":[]},{"oauth2":["read"]}],"tags":["Store"],"parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Store"}}}}}}},"/store/rating":{"get":{"summary":"Retrieve Store Rating","description":"Retrieve the aggregate store rating across all products and reviews.","operationId":"retrieve-rating","security":[{"apiKey":[]},{"oauth2":["read"]}],"tags":["Ratings","Store"],"parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AbstractRating"}}}}}}},"/store/reviews":{"get":{"summary":"List All Store Reviews","description":"Retrieve a list of store (overall experience) reviews. That is, retrieve all reviews that are about store and not about only 1 product.","operationId":"list-store-reviews","security":[{"apiKey":[]},{"oauth2":["read"]}],"tags":["Store","Reviews"],"parameters":[{"$ref":"#/components/parameters/pageRequestQueryParam"},{"$ref":"#/components/parameters/perPageRequestQueryParam"},{"$ref":"#/components/parameters/limitRequestQueryParam"},{"$ref":"#/components/parameters/offsetRequestQueryParam"},{"description":"Filter by Fera product ID or external product ID.","example":"fpro_123abc","name":"product.id","in":"query","schema":{"type":"string"}},{"in":"query","description":"Filter by multiple Fera product IDs or external product IDs. Comma-separated list or array of fields accepted.","example":"fpro_1abc,fpro_2def","name":"product.ids","schema":{"type":"string"}},{"in":"query","description":"Filter by Fera customer ID or external customer ID.","schema":{"type":"string"},"example":"fcus_12ab","name":"customer_id"},{"in":"query","description":"Filter by what the resource is describing; A specific product, the entire store (ie overall experience) or both (all). Default: both.","schema":{"type":"string","enum":["both","product","store"]},"example":"product","name":"subject"},{"allowEmptyValue":true,"in":"query","description":"Only show content submitted by verified sources (or unverified sources).","schema":{"type":"boolean"},"name":"verified"},{"description":"Search for customer reviews by rating.","example":"2;4","name":"rating","in":"query","schema":{"type":"string"}},{"example":"true","description":"Only show reviews with any textual content (summary or body).","name":"only_with_content","in":"query","schema":{"type":"string"}},{"name":"sort_by","in":"query","required":false,"description":"Sort (order) the response results by the given attribute.\n\nAdd `:desc` to sort in descending order, or `:asc` to sort in ascending order.\n\nFor example: created_at:desc would get you created_at in descending order.","schema":{"type":"string","enum":["created_at"]}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Review"}},"meta":{"$ref":"#/components/schemas/listMetaParam"}}}}}},"400":{"$ref":"#/components/responses/BadRequestError"}}}},"/store/media":{"get":{"summary":"List All Store Photos \u0026 Videos","description":"Retrieve a list of all photos and videos submitted by customers that are about\nthe store or overall experience.\n\nThis returns only photos/videos that are not linked to a specific product.","operationId":"list-store-media","security":[{"apiKey":[]},{"oauth2":["read"]}],"tags":["Store","Photos \u0026 Videos"],"parameters":[{"$ref":"#/components/parameters/pageRequestQueryParam"},{"$ref":"#/components/parameters/perPageRequestQueryParam"},{"$ref":"#/components/parameters/limitRequestQueryParam"},{"$ref":"#/components/parameters/offsetRequestQueryParam"},{"description":"Filter by Fera product ID or external product ID.","example":"fpro_123abc","name":"product.id","in":"query","schema":{"type":"string"}},{"in":"query","description":"Filter by multiple Fera product IDs or external product IDs. Comma-separated list or array of fields accepted.","example":"fpro_1abc,fpro_2def","name":"product.ids","schema":{"type":"string"}},{"in":"query","description":"Filter by Fera customer ID or external customer ID.","schema":{"type":"string"},"example":"fcus_12ab","name":"customer_id"},{"example":"ford_123","description":"Filter by Fera order ID or external order ID.","name":"order.id","in":"query","schema":{"type":"string"}},{"in":"query","description":"Filter by what the resource is describing; A specific product, the entire store (ie overall experience) or both (all). Default: both.","schema":{"type":"string","enum":["both","product","store"]},"example":"product","name":"subject"},{"allowEmptyValue":true,"in":"query","description":"Only show content submitted by verified sources (or unverified sources).","schema":{"type":"boolean"},"name":"verified"},{"example":"photo","description":"Type of media: `photo` or `video`.\n\n  Can also be used to filter the subject at the same time. For example: `product_photo`.","name":"type","in":"query","schema":{"type":"string"}},{"description":"Review that the media is a part of (submitted along with).","example":"frev_123abc","name":"review.id","in":"query","schema":{"type":"string"}},{"name":"sort_by","in":"query","required":false,"description":"Sort (order) the response results by the given attribute.\n\nAdd `:desc` to sort in descending order, or `:asc` to sort in ascending order.\n\nFor example: created_at:desc would get you created_at in descending order.","schema":{"type":"string","enum":["created_at"]}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Media"}},"meta":{"$ref":"#/components/schemas/listMetaParam"}}}}}},"400":{"$ref":"#/components/responses/BadRequestError"}}}}},"components":{"schemas":{"Widget":{"type":"object","properties":{"id":{"type":"string","description":"The Fera ID of the Widget.","example":"fWid_12ab"}}},"ContentCampaign":{"type":"object","properties":{"id":{"type":"string","description":"The Fera ID of the Campaign.","example":"fCam_12ab"},"created_at":{"type":"string","format":"date-time","description":"The time the object was created using ISO-8601 date/time format.","example":"2024-06-06T19:21:29.007Z"},"updated_at":{"type":"string","format":"date-time","description":"The time the object was last updated in Fera using ISO-8601 date/time format.","example":"2024-06-06T19:21:29.007Z"}}},"Submission":{"type":"object","properties":{"id":{"type":"string","description":"The Fera ID of the Submission.","example":"fSub_12ab"},"external_customer_id":{"type":"string","example":"12345678","description":"Related external customer ID (usually the Wix, Shopify or other eCommerce platform customer ID)."},"customer_id":{"type":"string","example":"fcus_12ab","description":"Related Fera customer ID."},"created_at":{"type":"string","format":"date-time","description":"The time the object was created using ISO-8601 date/time format.","example":"2024-06-06T19:21:29.007Z"},"updated_at":{"type":"string","format":"date-time","description":"The time the object was last updated in Fera using ISO-8601 date/time format.","example":"2024-06-06T19:21:29.008Z"},"customer":{"description":"Customer data related to the current object.","$ref":"#/components/schemas/CustomerWithoutNesting","nullable":true},"customer_message":{"$ref":"#/components/schemas/MessageWithoutNesting"},"content_campaign":{"$ref":"#/components/schemas/ContentCampaignWithoutNesting"}}},"Review":{"type":"object","properties":{"id":{"type":"string","description":"The Fera ID of the Review.","example":"fRev_12ab"},"subject":{"type":"string","description":"What is this content about - a specific product, or the store (overall experience)?","enum":["product","store"],"example":"store"},"is_verified":{"type":"boolean","description":"Was this resource submitted by a verified customer of the store?"},"is_test":{"type":"boolean","description":"Whether the resource was created as part of an administrative test (usually during setup).","example":false},"external_product_id":{"type":"string","example":"12345678","description":"Related external product ID (usually the Shopify, Wix or other eCommerce platform product ID)."},"product_id":{"type":"string","example":"fpro_12ab","description":"Related Fera product ID if product has not been deleted."},"external_customer_id":{"type":"string","example":"12345678","description":"Related external customer ID (usually the Wix, Shopify or other eCommerce platform customer ID)."},"customer_id":{"type":"string","example":"fcus_12ab","description":"Related Fera customer ID."},"created_at":{"type":"string","format":"date-time","description":"The time the object was created using ISO-8601 date/time format.","example":"2024-06-06T19:21:29.008Z"},"updated_at":{"type":"string","format":"date-time","description":"The time the object was last updated in Fera using ISO-8601 date/time format.","example":"2024-06-06T19:21:29.008Z"},"rating":{"type":"integer","description":"Rating between 1 and 5.","example":4,"minimum":1,"maximum":5,"format":"float"},"heading":{"type":"string","description":"A short summary of the review.","example":"This is a great product!","maxLength":255},"body":{"type":"string","description":"The full review.","example":"This is a great product! I love it!"},"is_from_supplier":{"type":"boolean","description":"Was this review collected by the merchant's supplier?","example":false},"store_reply":{"description":"Store admin reply to the customer's review, if any.","nullable":true,"type":"object","properties":{"body":{"type":"string","description":"The content body of the reply from the store owner or admin.","example":"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":{"type":"string","format":"date-time","description":"The time when the reply was created (when the store owner replied) using ISO-8601 date/time format."}}},"counts":{"description":"Cached counts of child objects.","type":"object","properties":{"media":{"type":"integer","description":"Number of photos and videos attached to this review. This number is equal to counts.photos + counts.videos.","example":3},"photos":{"type":"integer","description":"Number of photos attached to this review.","example":2},"videos":{"type":"integer","description":"Number of videos attached to this review.","example":1}}},"product":{"description":"Product data related to the current object.","$ref":"#/components/schemas/ProductWithoutNesting","nullable":true},"customer":{"description":"Customer data related to the current object.","$ref":"#/components/schemas/CustomerWithoutNesting","nullable":true},"media":{"type":"array","description":"Customer photos and videos that are associated to this object. Sorted by most recent first.","items":{"$ref":"#/components/schemas/MediaWithoutNesting"}}}},"Media":{"type":"object","properties":{"id":{"type":"string","description":"The Fera ID of the Media.","example":"fMed_12ab"},"subject":{"type":"string","description":"What is this content about - a specific product, or the store (overall experience)?","enum":["product","store"],"example":"product"},"is_verified":{"type":"boolean","description":"Was this resource submitted by a verified customer of the store?","example":true},"is_test":{"type":"boolean","description":"Whether the resource was created as part of an administrative test (usually during setup).","example":false},"external_product_id":{"type":"string","example":"12345678","description":"Related external product ID (usually the Shopify, Wix or other eCommerce platform product ID)."},"product_id":{"type":"string","example":"fpro_12ab","description":"Related Fera product ID if product has not been deleted."},"external_customer_id":{"type":"string","example":"12345678","description":"Related external customer ID (usually the Wix, Shopify or other eCommerce platform customer ID)."},"customer_id":{"type":"string","example":"fcus_12ab","description":"Related Fera customer ID."},"created_at":{"type":"string","format":"date-time","description":"The time the object was created using ISO-8601 date/time format.","example":"2024-06-06T19:21:29.024Z"},"updated_at":{"type":"string","format":"date-time","description":"The time the object was last updated in Fera using ISO-8601 date/time format.","example":"2024-06-06T19:21:29.024Z"},"type":{"type":"string","description":"Type of media. Possible values are: photo or video.","example":"photo"},"review_id":{"type":"string","description":"ID of the review that this photo or video was submitted as part of.","example":"frev_12ab"},"review_channel_code":{"type":"string","description":"Channel code for media synced from external channel.","example":"amazon"},"url":{"type":"string","format":"uri","description":"URL to the photo or video. If the resource is hosted an external server (like YouTube), then this URL will be the external URL.","example":"https://cdn.fera.ai/img/sunglasses.png"},"thumbnail_url":{"type":"string","format":"uri","description":"URL to an optimized small image that represents the photo or video. If the resource is hosted an\nexternal server (like YouTube), then this URL will be the external URL.","example":"https://cdn.fera.ai/img/sunglasses.png?size=thumbnail"},"processing_state":{"type":"string","description":"Upon upload of photos and videos a compressed copy and thumbnail are created. This process takes some time, so this attribute tells you whether or not it's finished.","enum":["not_started","enqueued","in_progress","completed","failed"],"example":"completed","readOnly":true},"channel_code":{"type":"string","description":"Channel code if media upload is from external source that is youtube, vimeo, instagram.","enum":["youtube","facebook","vimeo","instagram","external"],"example":"youtube"},"caption":{"type":"string","description":"Caption of the photo or video.","example":"Here's how my product purchase looked when I opened the box I received."},"product":{"description":"Product data related to the current object.","$ref":"#/components/schemas/ProductWithoutNesting","nullable":true},"customer":{"description":"Customer data related to the current object.","$ref":"#/components/schemas/CustomerWithoutNesting","nullable":true}}},"Customer":{"type":"object","properties":{"id":{"type":"string","description":"The Fera ID of the Serializer.","example":"fSer_12ab"},"display_name":{"type":"string","example":"George B.","description":"Public-safe name to display. If the customer's profile has no display name defined\nthen this returns a generated display name based on the store's settings."},"is_anonymous":{"type":"boolean","example":false,"description":"If true, the customer's display name will be the word 'Anonymous'."},"display_location":{"type":"string","example":"Austin, TX","description":"Public-safe location to display on customer profile. If the customer's profile has no display location\nvalue then returns a generated display location based on the customer's country, region and city while factoring in the store's location.\n\nFor example, if the store is located in the US then the generated location string will omit the 'US' country code part."},"avatar_url":{"type":"string","format":"uri","example":"https://cdn.fera.ai/img/shoppers/placeholder.png","description":"Public-safe customer display picture (avatar) URL."},"default_avatar_url":{"type":"string","format":"uri","example":"https://pic1.co/abc123.png","description":"A generated avatar URL for the customer. You can use this to confirm whether the `avatar_url` is the default avatar versus a custom one.","readOnly":true},"rating":{"readOnly":true,"type":"object","description":"Cached aggregate rating and review counts for the customer. Pending/unpublished content excluded.","properties":{"count":{"type":"number","format":"integer","example":5,"description":"The total number of reviews/ratings the customer has submitted.\n\nThis is the same as `counts.reviews`."},"average":{"type":"number","format":"float","example":4.5,"description":"The average rating the customer has submitted across all their submitted reviews/ratings\n(both store reviews and product reviews combined).\n\nThis is the same value is the `average_rating` attribute and `counts.average_rating`."}}},"counts":{"readOnly":true,"type":"object","description":"Cached counts related to the customer. Pending/unpublished content excluded.","properties":{"reviews":{"type":"number","format":"integer","example":5,"description":"The total number of reviews/ratings the customer has submitted.\n\nThis is the same as `rating.count`."},"average_rating":{"type":"number","format":"float","example":4.9,"description":"Average rating across all reviews submitted by this customer (same as `rating.average`)."},"media":{"type":"number","format":"integer","example":5,"description":"The total number of photos and videos the customer has submitted."}}},"created_at":{"type":"string","format":"date-time","description":"The date and time the customer was created. Takes the OLDEST of the external platform updated_at and Fera updated_at value.","example":"2020-01-01T00:00:00Z"},"updated_at":{"type":"string","format":"date-time","description":"The date and time the customer was last updated. Takes the MOST RECENT of the external platform updated_at and Fera updated_at value.","example":"2020-01-01T00:00:00Z"}}},"Message":{"type":"object","properties":{"id":{"type":"string","description":"The Fera ID of the Message.","example":"fMes_12ab"},"external_customer_id":{"type":"string","example":"12345678","description":"Related external customer ID (usually the Wix, Shopify or other eCommerce platform customer ID)."},"customer_id":{"type":"string","example":"fcus_12ab","description":"Related Fera customer ID."},"external_order_id":{"type":"string","example":"12345678","description":"Related external order ID (usually the Shopify, Wix or other eCommerce platform order ID)."},"order_id":{"type":"string","example":"ford_12ab","description":"Related Fera order ID."},"created_at":{"type":"string","format":"date-time","description":"The time the object was created using ISO-8601 date/time format.","example":"2024-06-06T19:21:29.127Z"},"updated_at":{"type":"string","format":"date-time","description":"The time the object was last updated in Fera using ISO-8601 date/time format.","example":"2024-06-06T19:21:29.127Z"},"customer":{"description":"Customer data related to the current object.","$ref":"#/components/schemas/CustomerWithoutNesting","nullable":true},"content_campaign":{"$ref":"#/components/schemas/ContentCampaignWithoutNesting"},"products":{"type":"array","description":"Products that are associated to this object.","items":{"$ref":"#/components/schemas/ProductWithoutNesting"}},"submissions":{"type":"array","description":"Content submissions that are associated to this object.","items":{"$ref":"#/components/schemas/SubmissionWithoutNesting"}},"active_submission":{"description":"The active content submission that is associated to this object.","$ref":"#/components/schemas/SubmissionWithoutNesting"},"reviews":{"type":"array","description":"Customer reviews that are associated to this object.","items":{"$ref":"#/components/schemas/ReviewWithoutNesting"}}}},"Product":{"type":"object","properties":{"id":{"type":"string","description":"The Fera ID of the Product.","example":"fPro_12ab"},"external_id":{"type":"string","example":"12345678","description":"External product ID (usually the Wix, Shopify or other eCommerce platform product ID)."},"name":{"type":"string","example":"Red Sneakers","description":"Name/title of the product."},"url":{"type":"string","format":"uri","example":"https://www.example.com/red-sneakers","description":"URL to the product's detail page in the store. Returns `null` if the product is unpublished or deleted."},"handle":{"type":"string","example":"nike-air-jordan-sneakers","description":"The URL handle (AKA URL key, AKA slug) that can be used to generate a URL to the product.\nThis will be used to generate a URL to the product if a URL is not specified. Example: `example.com/us/HANDLE`."},"thumbnail_url":{"type":"string","format":"uri","example":"https://cdn.fera.ai/img/sunglasses.png","description":"URL to a small (300x300px) photo of the product."},"rating":{"readOnly":true,"type":"object","properties":{"count":{"type":"number","format":"int64","example":5,"description":"The total number of reviews/ratings the product has received.\n\n    This is the same as `counts.reviews`."},"average":{"type":"number","format":"float","example":4.5,"description":"The average rating the product has received across all its submitted reviews/ratings."}}},"counts":{"readOnly":true,"type":"object","description":"Cached counts related to the product.","properties":{"reviews":{"type":"number","format":"int64","example":5,"description":"The total number of reviews/ratings associated with the product.\n\n    This is the same as `rating.count`."},"media":{"type":"number","format":"int64","example":3,"description":"The total number of photos and videos associated with the product.\n\n    This is equal to `counts.photos + counts.videos`."},"photos":{"type":"number","format":"int64","example":2,"description":"The total number of photos associated with the product."},"videos":{"type":"number","format":"int64","example":1,"description":"The total number of videos associated with the product."}}},"is_visible":{"type":"boolean","example":true,"description":"Whether the product is visible in the storefront. A product is not visible if its `status` field is `draft`,\n`unpublished`, `deleted`, `archived` or something similar."}}},"Store":{"type":"object","properties":{"id":{"type":"string","description":"The Fera ID of the Store.","example":"fSto_12ab"},"name":{"type":"string","example":"Bluth Building Co","description":"Name/title of the store/account."},"platform":{"type":"string","example":"shopify","description":"The eCommerce platform where most orders and products live."},"url":{"type":"string","format":"uri","example":"https://www.example.com","description":"URL the store that should be used in links."},"code":{"type":"string","example":"bluth","description":"Short code used for review quick links (`fera.review/{ code }`) and other things."},"country_code":{"type":"string","example":"US","description":"Country code where the store's primary headquarters are."},"country_name":{"type":"string","example":"US","description":"Name of country where the store's primary headquarters are.","readOnly":true},"public_key":{"type":"string","example":"pk_abcd123","description":"Public API key used to access data via the [Public/Storefront API](https://developers.fera.ai/public-api"},"external_id":{"type":"string","example":"bluth-co.myshopify.com","description":"Unique identifier used by the eCommerce platform to identify the store."},"language":{"type":"string","example":"en-US","description":"The primary language of the store (the base one). Language code is in the format: xx-XX","default":"en"},"supported_language":{"type":"string","example":"en-US","description":"The primary language of the store that Fera supports. If the store's language is not supported, then this will return 'en'. Language code is in the format: xx-XX"},"logo_url":{"type":"string","format":"uri","example":"https://uploads.fera.ai/brand/v3/logo.svg","description":"URL to the company's logo image."},"icon_url":{"type":"string","format":"uri","example":"https://uploads.fera.ai/brand/v3/icon.svg","description":"URL to the company's logo icon. This is used when the store replies to reviews publicly as well as a couple other places."},"counts":{"readOnly":true,"type":"object","description":"Cached counts related to the store.","properties":{"reviews":{"type":"number","format":"int64","example":5,"description":"The total number of reviews/ratings received from customers.\n\n    This is the same as `rating.count`."},"media":{"type":"number","format":"int64","example":3,"description":"The total number of photos and videos the store has across all products and types."}}},"rating":{"readOnly":true,"type":"object","properties":{"count":{"type":"number","format":"int64","example":5,"description":"The total number of reviews/ratings received from customers.\n\n    This is the same as `counts.reviews`."},"average":{"type":"number","format":"float","example":4.5,"description":"The store's overall average rating across all products and reviews."}}},"is_dev_mode":{"type":"boolean","description":"Is [development mode](https://help.fera.ai/en/articles/6754920-development-mode-flag) activated?","example":false},"created_at":{"type":"string","format":"date-time","description":"The time the object was created using ISO-8601 date/time format.","example":"2024-06-06T19:21:29.437Z"},"updated_at":{"type":"string","format":"date-time","description":"The time the object was last updated in Fera using ISO-8601 date/time format.","example":"2024-06-06T19:21:29.437Z"},"widgets":{"type":"array","items":{"$ref":"#/components/schemas/WidgetWithoutNesting"}}}},"Rating":{"type":"object","properties":{"subject":{"type":"string","description":"What is this content about - a specific product, or the store (overall experience)?","enum":["product","store"],"example":"product"},"external_product_id":{"type":"string","example":"12345678","description":"Related external product ID (usually the Shopify, Wix or other eCommerce platform product ID)."},"product_id":{"type":"string","example":"fpro_12ab","description":"Related Fera product ID if product has not been deleted."},"average":{"type":"number","format":"float","description":"Average rating of the subject (product or store). Only approved reviews/ratings are included in this count.","example":4.8,"readOnly":true},"count":{"type":"number","format":"int32","description":"Total number of reviews received about the subject (product or store). Only approved reviews/ratings are included in this count.","example":123,"readOnly":true},"ungrouped_average":{"type":"number","format":"float","description":"Average product rating without [product grouping](https://help.fera.ai/en/articles/5899894-product-groups-grouping-reviews) applied.","example":4.7,"readOnly":true},"ungrouped_count":{"type":"number","format":"int32","description":"Total number of product reviews/ratings without\n[product grouping](https://help.fera.ai/en/articles/5899894-product-groups-grouping-reviews) applied.","example":12,"readOnly":true}}},"WidgetWithoutNesting":{"type":"object","properties":{"id":{"type":"string","description":"The Fera ID of the Widget.","example":"fWid_12ab"}}},"ContentCampaignWithoutNesting":{"type":"object","properties":{"id":{"type":"string","description":"The Fera ID of the Campaign.","example":"fCam_12ab"},"created_at":{"type":"string","format":"date-time","description":"The time the object was created using ISO-8601 date/time format.","example":"2024-06-06T19:21:29.669Z"},"updated_at":{"type":"string","format":"date-time","description":"The time the object was last updated in Fera using ISO-8601 date/time format.","example":"2024-06-06T19:21:29.669Z"}}},"SubmissionWithoutNesting":{"type":"object","properties":{"id":{"type":"string","description":"The Fera ID of the Submission.","example":"fSub_12ab"},"external_customer_id":{"type":"string","example":"12345678","description":"Related external customer ID (usually the Wix, Shopify or other eCommerce platform customer ID)."},"customer_id":{"type":"string","example":"fcus_12ab","description":"Related Fera customer ID."},"created_at":{"type":"string","format":"date-time","description":"The time the object was created using ISO-8601 date/time format.","example":"2024-06-06T19:21:29.670Z"},"updated_at":{"type":"string","format":"date-time","description":"The time the object was last updated in Fera using ISO-8601 date/time format.","example":"2024-06-06T19:21:29.670Z"}}},"ReviewWithoutNesting":{"type":"object","properties":{"id":{"type":"string","description":"The Fera ID of the Review.","example":"fRev_12ab"},"subject":{"type":"string","description":"What is this content about - a specific product, or the store (overall experience)?","enum":["product","store"],"example":"store"},"is_verified":{"type":"boolean","description":"Was this resource submitted by a verified customer of the store?"},"is_test":{"type":"boolean","description":"Whether the resource was created as part of an administrative test (usually during setup).","example":false},"external_product_id":{"type":"string","example":"12345678","description":"Related external product ID (usually the Shopify, Wix or other eCommerce platform product ID)."},"product_id":{"type":"string","example":"fpro_12ab","description":"Related Fera product ID if product has not been deleted."},"external_customer_id":{"type":"string","example":"12345678","description":"Related external customer ID (usually the Wix, Shopify or other eCommerce platform customer ID)."},"customer_id":{"type":"string","example":"fcus_12ab","description":"Related Fera customer ID."},"created_at":{"type":"string","format":"date-time","description":"The time the object was created using ISO-8601 date/time format.","example":"2024-06-06T19:21:29.671Z"},"updated_at":{"type":"string","format":"date-time","description":"The time the object was last updated in Fera using ISO-8601 date/time format.","example":"2024-06-06T19:21:29.671Z"},"rating":{"type":"integer","description":"Rating between 1 and 5.","example":4,"minimum":1,"maximum":5,"format":"float"},"heading":{"type":"string","description":"A short summary of the review.","example":"This is a great product!","maxLength":255},"body":{"type":"string","description":"The full review.","example":"This is a great product! I love it!"},"is_from_supplier":{"type":"boolean","description":"Was this review collected by the merchant's supplier?","example":false},"store_reply":{"description":"Store admin reply to the customer's review, if any.","nullable":true,"type":"object","properties":{"body":{"type":"string","description":"The content body of the reply from the store owner or admin.","example":"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":{"type":"string","format":"date-time","description":"The time when the reply was created (when the store owner replied) using ISO-8601 date/time format."}}},"counts":{"description":"Cached counts of child objects.","type":"object","properties":{"media":{"type":"integer","description":"Number of photos and videos attached to this review. This number is equal to counts.photos + counts.videos.","example":3},"photos":{"type":"integer","description":"Number of photos attached to this review.","example":2},"videos":{"type":"integer","description":"Number of videos attached to this review.","example":1}}}}},"MediaWithoutNesting":{"type":"object","properties":{"id":{"type":"string","description":"The Fera ID of the Media.","example":"fMed_12ab"},"subject":{"type":"string","description":"What is this content about - a specific product, or the store (overall experience)?","enum":["product","store"],"example":"product"},"is_verified":{"type":"boolean","description":"Was this resource submitted by a verified customer of the store?","example":true},"is_test":{"type":"boolean","description":"Whether the resource was created as part of an administrative test (usually during setup).","example":false},"external_product_id":{"type":"string","example":"12345678","description":"Related external product ID (usually the Shopify, Wix or other eCommerce platform product ID)."},"product_id":{"type":"string","example":"fpro_12ab","description":"Related Fera product ID if product has not been deleted."},"external_customer_id":{"type":"string","example":"12345678","description":"Related external customer ID (usually the Wix, Shopify or other eCommerce platform customer ID)."},"customer_id":{"type":"string","example":"fcus_12ab","description":"Related Fera customer ID."},"created_at":{"type":"string","format":"date-time","description":"The time the object was created using ISO-8601 date/time format.","example":"2024-06-06T19:21:29.687Z"},"updated_at":{"type":"string","format":"date-time","description":"The time the object was last updated in Fera using ISO-8601 date/time format.","example":"2024-06-06T19:21:29.687Z"},"type":{"type":"string","description":"Type of media. Possible values are: photo or video.","example":"photo"},"review_id":{"type":"string","description":"ID of the review that this photo or video was submitted as part of.","example":"frev_12ab"},"review_channel_code":{"type":"string","description":"Channel code for media synced from external channel.","example":"amazon"},"url":{"type":"string","format":"uri","description":"URL to the photo or video. If the resource is hosted an external server (like YouTube), then this URL will be the external URL.","example":"https://cdn.fera.ai/img/sunglasses.png"},"thumbnail_url":{"type":"string","format":"uri","description":"URL to an optimized small image that represents the photo or video. If the resource is hosted an\nexternal server (like YouTube), then this URL will be the external URL.","example":"https://cdn.fera.ai/img/sunglasses.png?size=thumbnail"},"processing_state":{"type":"string","description":"Upon upload of photos and videos a compressed copy and thumbnail are created. This process takes some time, so this attribute tells you whether or not it's finished.","enum":["not_started","enqueued","in_progress","completed","failed"],"example":"completed","readOnly":true},"channel_code":{"type":"string","description":"Channel code if media upload is from external source that is youtube, vimeo, instagram.","enum":["youtube","facebook","vimeo","instagram","external"],"example":"youtube"},"caption":{"type":"string","description":"Caption of the photo or video.","example":"Here's how my product purchase looked when I opened the box I received."}}},"CustomerWithoutNesting":{"type":"object","properties":{"id":{"type":"string","description":"The Fera ID of the Serializer.","example":"fSer_12ab"},"display_name":{"type":"string","example":"George B.","description":"Public-safe name to display. If the customer's profile has no display name defined\nthen this returns a generated display name based on the store's settings."},"is_anonymous":{"type":"boolean","example":false,"description":"If true, the customer's display name will be the word 'Anonymous'."},"display_location":{"type":"string","example":"Austin, TX","description":"Public-safe location to display on customer profile. If the customer's profile has no display location\nvalue then returns a generated display location based on the customer's country, region and city while factoring in the store's location.\n\nFor example, if the store is located in the US then the generated location string will omit the 'US' country code part."},"avatar_url":{"type":"string","format":"uri","example":"https://cdn.fera.ai/img/shoppers/placeholder.png","description":"Public-safe customer display picture (avatar) URL."},"default_avatar_url":{"type":"string","format":"uri","example":"https://pic1.co/abc123.png","description":"A generated avatar URL for the customer. You can use this to confirm whether the `avatar_url` is the default avatar versus a custom one.","readOnly":true},"rating":{"readOnly":true,"type":"object","description":"Cached aggregate rating and review counts for the customer. Pending/unpublished content excluded.","properties":{"count":{"type":"number","format":"integer","example":5,"description":"The total number of reviews/ratings the customer has submitted.\n\nThis is the same as `counts.reviews`."},"average":{"type":"number","format":"float","example":4.5,"description":"The average rating the customer has submitted across all their submitted reviews/ratings\n(both store reviews and product reviews combined).\n\nThis is the same value is the `average_rating` attribute and `counts.average_rating`."}}},"counts":{"readOnly":true,"type":"object","description":"Cached counts related to the customer. Pending/unpublished content excluded.","properties":{"reviews":{"type":"number","format":"integer","example":5,"description":"The total number of reviews/ratings the customer has submitted.\n\nThis is the same as `rating.count`."},"average_rating":{"type":"number","format":"float","example":4.9,"description":"Average rating across all reviews submitted by this customer (same as `rating.average`)."},"media":{"type":"number","format":"integer","example":5,"description":"The total number of photos and videos the customer has submitted."}}},"created_at":{"type":"string","format":"date-time","description":"The date and time the customer was created. Takes the OLDEST of the external platform updated_at and Fera updated_at value.","example":"2020-01-01T00:00:00Z"},"updated_at":{"type":"string","format":"date-time","description":"The date and time the customer was last updated. Takes the MOST RECENT of the external platform updated_at and Fera updated_at value.","example":"2020-01-01T00:00:00Z"}}},"MessageWithoutNesting":{"type":"object","properties":{"id":{"type":"string","description":"The Fera ID of the Message.","example":"fMes_12ab"},"external_customer_id":{"type":"string","example":"12345678","description":"Related external customer ID (usually the Wix, Shopify or other eCommerce platform customer ID)."},"customer_id":{"type":"string","example":"fcus_12ab","description":"Related Fera customer ID."},"external_order_id":{"type":"string","example":"12345678","description":"Related external order ID (usually the Shopify, Wix or other eCommerce platform order ID)."},"order_id":{"type":"string","example":"ford_12ab","description":"Related Fera order ID."},"created_at":{"type":"string","format":"date-time","description":"The time the object was created using ISO-8601 date/time format.","example":"2024-06-06T19:21:29.790Z"},"updated_at":{"type":"string","format":"date-time","description":"The time the object was last updated in Fera using ISO-8601 date/time format.","example":"2024-06-06T19:21:29.790Z"}}},"ProductWithoutNesting":{"type":"object","properties":{"id":{"type":"string","description":"The Fera ID of the Product.","example":"fPro_12ab"},"external_id":{"type":"string","example":"12345678","description":"External product ID (usually the Wix, Shopify or other eCommerce platform product ID)."},"name":{"type":"string","example":"Red Sneakers","description":"Name/title of the product."},"url":{"type":"string","format":"uri","example":"https://www.example.com/red-sneakers","description":"URL to the product's detail page in the store. Returns `null` if the product is unpublished or deleted."},"handle":{"type":"string","example":"nike-air-jordan-sneakers","description":"The URL handle (AKA URL key, AKA slug) that can be used to generate a URL to the product.\nThis will be used to generate a URL to the product if a URL is not specified. Example: `example.com/us/HANDLE`."},"thumbnail_url":{"type":"string","format":"uri","example":"https://cdn.fera.ai/img/sunglasses.png","description":"URL to a small (300x300px) photo of the product."},"rating":{"readOnly":true,"type":"object","properties":{"count":{"type":"number","format":"int64","example":5,"description":"The total number of reviews/ratings the product has received.\n\n    This is the same as `counts.reviews`."},"average":{"type":"number","format":"float","example":4.5,"description":"The average rating the product has received across all its submitted reviews/ratings."}}},"counts":{"readOnly":true,"type":"object","description":"Cached counts related to the product.","properties":{"reviews":{"type":"number","format":"int64","example":5,"description":"The total number of reviews/ratings associated with the product.\n\n    This is the same as `rating.count`."},"media":{"type":"number","format":"int64","example":3,"description":"The total number of photos and videos associated with the product.\n\n    This is equal to `counts.photos + counts.videos`."},"photos":{"type":"number","format":"int64","example":2,"description":"The total number of photos associated with the product."},"videos":{"type":"number","format":"int64","example":1,"description":"The total number of videos associated with the product."}}},"is_visible":{"type":"boolean","example":true,"description":"Whether the product is visible in the storefront. A product is not visible if its `status` field is `draft`,\n`unpublished`, `deleted`, `archived` or something similar."}}},"StoreWithoutNesting":{"type":"object","properties":{"id":{"type":"string","description":"The Fera ID of the Store.","example":"fSto_12ab"},"name":{"type":"string","example":"Bluth Building Co","description":"Name/title of the store/account."},"platform":{"type":"string","example":"shopify","description":"The eCommerce platform where most orders and products live."},"url":{"type":"string","format":"uri","example":"https://www.example.com","description":"URL the store that should be used in links."},"code":{"type":"string","example":"bluth","description":"Short code used for review quick links (`fera.review/{ code }`) and other things."},"country_code":{"type":"string","example":"US","description":"Country code where the store's primary headquarters are."},"country_name":{"type":"string","example":"US","description":"Name of country where the store's primary headquarters are.","readOnly":true},"public_key":{"type":"string","example":"pk_abcd123","description":"Public API key used to access data via the [Public/Storefront API](https://developers.fera.ai/public-api"},"external_id":{"type":"string","example":"bluth-co.myshopify.com","description":"Unique identifier used by the eCommerce platform to identify the store."},"language":{"type":"string","example":"en-US","description":"The primary language of the store (the base one). Language code is in the format: xx-XX","default":"en"},"supported_language":{"type":"string","example":"en-US","description":"The primary language of the store that Fera supports. If the store's language is not supported, then this will return 'en'. Language code is in the format: xx-XX"},"logo_url":{"type":"string","format":"uri","example":"https://uploads.fera.ai/brand/v3/logo.svg","description":"URL to the company's logo image."},"icon_url":{"type":"string","format":"uri","example":"https://uploads.fera.ai/brand/v3/icon.svg","description":"URL to the company's logo icon. This is used when the store replies to reviews publicly as well as a couple other places."},"counts":{"readOnly":true,"type":"object","description":"Cached counts related to the store.","properties":{"reviews":{"type":"number","format":"int64","example":5,"description":"The total number of reviews/ratings received from customers.\n\n    This is the same as `rating.count`."},"media":{"type":"number","format":"int64","example":3,"description":"The total number of photos and videos the store has across all products and types."}}},"rating":{"readOnly":true,"type":"object","properties":{"count":{"type":"number","format":"int64","example":5,"description":"The total number of reviews/ratings received from customers.\n\n    This is the same as `counts.reviews`."},"average":{"type":"number","format":"float","example":4.5,"description":"The store's overall average rating across all products and reviews."}}},"is_dev_mode":{"type":"boolean","description":"Is [development mode](https://help.fera.ai/en/articles/6754920-development-mode-flag) activated?","example":false},"created_at":{"type":"string","format":"date-time","description":"The time the object was created using ISO-8601 date/time format.","example":"2024-06-06T19:21:30.087Z"},"updated_at":{"type":"string","format":"date-time","description":"The time the object was last updated in Fera using ISO-8601 date/time format.","example":"2024-06-06T19:21:30.087Z"}}},"RatingWithoutNesting":{"type":"object","properties":{"subject":{"type":"string","description":"What is this content about - a specific product, or the store (overall experience)?","enum":["product","store"],"example":"product"},"external_product_id":{"type":"string","example":"12345678","description":"Related external product ID (usually the Shopify, Wix or other eCommerce platform product ID)."},"product_id":{"type":"string","example":"fpro_12ab","description":"Related Fera product ID if product has not been deleted."},"average":{"type":"number","format":"float","description":"Average rating of the subject (product or store). Only approved reviews/ratings are included in this count.","example":4.8,"readOnly":true},"count":{"type":"number","format":"int32","description":"Total number of reviews received about the subject (product or store). Only approved reviews/ratings are included in this count.","example":123,"readOnly":true},"ungrouped_average":{"type":"number","format":"float","description":"Average product rating without [product grouping](https://help.fera.ai/en/articles/5899894-product-groups-grouping-reviews) applied.","example":4.7,"readOnly":true},"ungrouped_count":{"type":"number","format":"int32","description":"Total number of product reviews/ratings without\n[product grouping](https://help.fera.ai/en/articles/5899894-product-groups-grouping-reviews) applied.","example":12,"readOnly":true}}},"listMetaParam":{"type":"object","description":"Pagination and count information about the list of objects retrieved.","properties":{"page":{"type":"integer","description":"Current page number, if pagination used.","example":1},"page_size":{"type":"integer","description":"Number of items per page, if pagination used.","example":10},"page_count":{"type":"integer","description":"Total number of pages, if pagination used.","example":3},"limit":{"type":"integer","description":"Maximum number of items retrieved, if offset/limits used.","example":10},"offset":{"type":"integer","description":"Starting position of items request query, if offset/limits used.","example":0},"total_count":{"type":"integer","description":"Total number of items that the query matched (without pagination,\nlimits or offsets).","example":123}}},"AbstractRating":{"type":"object","properties":{"rating":{"type":"number","format":"float","description":"Average rating.","example":4.8},"count":{"type":"number","format":"int32","description":"Number of reviews/ratings.","example":10}}},"Address":{"type":"object","properties":{"company":{"type":"string","description":"Company name.","example":"Fera"},"name":{"type":"string","description":"Full name.","example":"John Doe"},"address1":{"type":"string","description":"Address line 1.","example":"123 Main St"},"address2":{"type":"string","description":"Address line 2.","example":"Apt. 1"},"city_name":{"type":"string","description":"City name.","example":"Los Angeles"},"region_name":{"type":"string","description":"Region name like state or province","example":"California"},"country_code":{"type":"string","description":"2 character country code.","example":"US"},"zip_code":{"type":"string","description":"Zip/postal code.","example":"90210"},"phone":{"type":"string","description":"Phone number.","example":"555-555-5555"}}},"LineItem":{"type":"object","properties":{"product_id":{"type":"string","description":"Product ID.","example":"1234"},"variant_id":{"type":"string","description":"Product variant ID.","example":"1234"},"quantity":{"type":"integer","description":"Quantity.","example":1},"name":{"type":"string","description":"Product name.","example":"Cool T-Shirt"},"total":{"type":"number","description":"Total price of the line item.","example":10.0},"total_usd":{"type":"number","description":"Total price of the line item in USD.","example":8.99}}}},"parameters":{"pageRequestQueryParam":{"name":"page","in":"query","required":false,"description":"Current page number, if pagination used.","schema":{"type":"integer","format":"int32","minimum":1}},"perPageRequestQueryParam":{"name":"page_size","in":"query","required":false,"description":"Number of items per page.","schema":{"type":"integer","format":"int32","minimum":1}},"limitRequestQueryParam":{"name":"limit","in":"query","required":false,"description":"Maximum number of items retrieved.","schema":{"type":"integer","format":"int32","minimum":1,"maximum":100}},"offsetRequestQueryParam":{"name":"offset","in":"query","required":false,"description":"Starting position of items request query.","schema":{"type":"integer","format":"int32","minimum":0}},"idRequestUrlParam":{"name":"id","in":"path","required":true,"description":"ID of the object you want to retrieve","schema":{"type":"string"}},"idOrExternalIdRequestUrlParam":{"name":"id","in":"path","required":true,"description":"ID of the object you want to retrieve. The Fera ID or external ID of the object can be used here for convenience.","schema":{"type":"string"}}},"responses":{"BadRequestError":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"A message describing the error in English","example":"Your request was malformed or unacceptable. Please check your parameters and try again."}}}}}},"ValidationError":{"description":"Validation error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"A message describing the error in English","example":"Rating must be a number between 1 and 5."},"errors":{"type":"object","description":"An object where the keys are the attribute that failed validation, and the values are an array of problems.","example":{"rating":["must be a positive integer","must be between 1 and 5"]}}}}}}},"NotFoundError":{"description":"Not found error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"The object you requested was not found."}}}}}},"ProductNotFoundError":{"description":"Product not found error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"The product you requested was not found."}}}}}},"ReviewNotFoundError":{"description":"Review not found error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"The review you requested was not found."}}}}}},"CustomerNotFoundError":{"description":"Customer not found error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"The customer you requested was not found."}}}}}},"MethodNotAllowedError":{"description":"Not allowed error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"A message describing the error in English","example":"You cannot delete this review because it was submitted by a verified customer. Try requesting an update instead."}}}}}}},"securitySchemes":{"apiKey":{"type":"apiKey","in":"query","name":"public_key","description":"You can find your store/account's Public API key in the [Apps \u0026 Integrations section of your Fera admin under 'Api Keys' here](https://app.fera.ai/integrations/api_keys?ref=open_api\u0026api_type=public\u0026user_type=developer)."}}},"info":{"description":"\n# Introduction\nWelcome to the Fera reviews and user-generated content Public API (aka Storefront API).\n\nThis API is meant to allow developers to safely, quickly and easily fetch and display customer reviews, photos and videos\nwithin the storefront.\n\nPlease visit [developers.fera.ai](https://developers.fera.ai?ref=open_api\u0026api_type=public) for our full API docs information or visit\n[our website](https://www.fera.ai?ref=open_api\u0026type=developer\u0026api_type=public) to learn more about what Fera is and how you can use it.\n\n## Private vs Public API\nThis documentation is for the **PUBLIC Fera API**.\n\nYou can assume all the data you access from this API is safe to display to shoppers of your site.\n\nIf you're looking to fetch private customer review and other data through a sever-side integration, please check out\nout the [Fera Private API](https://developers.fera.ai/reference).\n\n## Fera.js (SDK)\nYou can easily interface with this API without writing much code by using [Fera.js](https://developers.fera.ai/docs/fera-js-intro), an\neasy-to-use JavaScript SDK To fetch and display your reviews as well as request reviews.\n\n## Request Format\nFera follows a RESTful API design pattern. Most things should be intuitive to those that are familiar with REST.\n\nThe Fera API accepts `multi-part/form` or `application/json` request bodies but will always respond with `application/json`.\n\n### Authentication\nThe Fera API only requires your store's public API key. Simply include it as the `api_key` parameter in all your requests\nto authenticate.\n\n### Rate Limits\nIf you hit our rate limits you will receive 429 error as is standard for any API.\n\nMost Fera accounts have a 60 request per minute limit, however you can contact us to request a higher rate limit if you need it.\n\n## Response Format\n### Create and update response structure\nCreate and update operations will return a JSON response with the data of the modified object.\n\n### List response structure\nList responses will always return a JSON array where there is a `data` key that contains the list items and a `meta` key\nthat contains pagination.\n\n#### Pagination\nFor any list requests you can include a `page` parameter to navigate between pages of data.\n\nYou'll also receive a `meta` attribute that contains the total number of items in the list, total pages, etc.\n\nIf you prefer, list requests also accept a `limit` and `offset` parameter if you prefer to do your own pagination.\n\n### Error responses\nUnsuccessful responses will always return a JSON object that contains a `message` key that tells you what the error was\nin plain English.\n\nSome unsuccessful responses will also include an `errors` object where the key is the problematic field (like for example\nthe one that failed validation) and\nthe value is an array of problems (like what's wrong with them).\n\n## Other good things to know\n- Fera object IDs always start with 'f'. They are universally unique within Fera, but not meant to be used as security\ntokens (so please do not do that).\n- If you're using a filter or endpoint that isn't documented it's probably because we added an alias for the real endpoint,\n which should be documented here. We recommend you use the documented endpoints and filters at all times when possible.\n- If you're stuck on something please reach out to our support team via the live chat one our site. Tell them you're a\ndeveloper and they'll make sure you get more 'technical' attention.\n\n","version":"3.15.0","title":"Fera Public API","x-logo":{"url":"https://uploads.fera.ai/brand/logo-rect.svg","altText":"Fera logo"},"termsOfService":"https://www.fera.ai/terms-of-service?ref=open_api\u0026user_type=developer\u0026api_type=public","contact":{"name":"Fera Support Team","email":"help@fera.ai","url":"https://help.fera.ai?ref=open_api\u0026user_type=developer"}},"servers":[{"url":"https://api.fera.ai/v3/public"}],"externalDocs":{"description":"Find out more about Fera","url":"https://www.fera.ai?ref=open_api\u0026user_type=developer\u0026api_type=public"}}