{"id":"4599aa3f-e4e6-4c65-83f8-e1485f76aebc","createdDate":"2024-07-09T07:37:59.740Z","updatedDate":"2024-07-09T07:37:59.740Z","resourceId":"2fe27377-f702-4993-a463-fcff15831a52","api":{"schema":{"object":{"displayName":"Review Object","description":"A Review object includes all of the details related to the review of an entity. An entity is a specific resource to be reviewed,\nfor example, a store product.\nYou can manage existing reviews, create new reviews, and retrieve reviews.\nRead more about reviews in this [tutorial](https://support.wix.com/en/article/wix-stores-adding-and-setting-up-wix-reviews).","slug":"review-object","$ref":"#/components/schemas/com.wixpress.critique.reviews.Review","legacyExamples":[{"title":"Review","content":"{\n \"id\": \"605c64b4-d40c-4d53-a777-015209763905\",\n \"revision\": \"1\",\n \"namespace\": \"stores\",\n \"entityId\": \"df19c1f7-07d8-a265-42f8-e8dfa824cc6e\",\n \"content\": \n {\n \"title\": \"Excellent Laptop with Great Features\",\n \"body\": \"This laptop excels in speed, battery life, display quality, and is great for both work and gaming.\",\n \"media\": \n [\n {\n \"image\": \n {\n \"id\": \"344592895_182127404391791_355010341914573594_n~mv2.jpeg\",\n \"url\": \"https://static.wixstatic.com/media/344592895_182127404391791_355010341914573594_n~mv2.jpeg\",\n \"height\": 1976,\n \"width\": 1572,\n \"altText\": \"laptop.jpeg\",\n \"filename\": \"laptop.jpeg\"\n }\n }\n ],\n \"rating\": 4\n },\n \"createdDate\": \"2023-05-15T13:09:26.856Z\",\n \"updatedDate\": \"2023-05-15T13:09:27.270Z\",\n \"author\": \n {\n \"contactId\": \"453faee9-8e67-45f1-87dc-f247bdf3510e\",\n \"authorName\": \"Joey\"\n },\n \"foundHelpful\": 0,\n \"foundUnhelpful\": 0,\n \"helpfulness\": 0,\n \"moderation\": \n {\n \"moderationStatus\": \"APPROVED\",\n \"manuallyChanged\": false\n },\n \"verified\": false,\n \"origin\": {\n \"type\": \"ORGANIC\"\n },\n \"publishCount\": 1\n}\n"}],"sourceRepo":"git@github.com:wix-private/app-market.git"},"methods":[{"summary":"Get Review","description":"Retrieves a review by ID.\n\nTo include unpublished reviews, pass `returnPrivateReviews` as `true`. By default, unpublished\nreviews are not returned.","operationId":"com.wixpress.critique.reviews.Reviews.GetReview","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"reviewId","description":"Review ID.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},{"name":"returnPrivateReviews","in":"query","description":"Whether to return private (unpublished) reviews.\n\nDefault: `false`","required":false,"schema":{"description":"Whether to return private (unpublished) reviews.\n\nDefault: `false`","title":"returnPrivateReviews","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.critique.reviews.GetReviewResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/reviews/v1/reviews","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/reviews/v1/reviews","destinationPath":"/v1/reviews","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.critique.reviews.Reviews","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["REVIEWS.READ_REVIEWS","REVIEWS.READ_PRIVATE_REVIEWS"],"applicableIdentities":["APP","MEMBER","VISITOR"],"externalPermissionScopes":[{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Read reviews","scopeId":"SCOPE.DC-REVIEWS.READ-REVIEWS"},{"name":"Manage Reviews","scopeId":"SCOPE.DC-REVIEWS.MANAGE-REVIEWS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"name":"Manage Reviews","scopeId":"SCOPE.DC-REVIEWS.MANAGE-REVIEWS"}],"protoArtifactId":"com.wixpress.critique:reviews","serviceArtifactId":"com.wixpress.critique.reviews","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.critique.reviews.GetReviewRequest","responseMessage":"com.wixpress.critique.reviews.GetReviewResponse"},"legacyExamples":[{"name":"GetReview","type":"METHOD","content":{"title":"Get Published Review","description":"Gets a review. Returns review only if published.","request":"curl GET \\\n 'https://www.wixapis.com/reviews/v1/reviews/605c64b4-d40c-4d53-a777-015209763905' \\\n -H 'Content-Type: application/json;charset=UTF-8' \\\n -H 'Authorization: '","response":"{\n \"review\": \n {\n \"id\": \"605c64b4-d40c-4d53-a777-015209763905\",\n \"revision\": \"1\",\n \"namespace\": \"stores\",\n \"entityId\": \"df19c1f7-07d8-a265-42f8-e8dfa824cc6e\",\n \"content\": \n {\n \"title\": \"Excellent Laptop with Great Features\",\n \"body\": \"This laptop excels in speed, battery life, display quality, and is great for both work and gaming.\",\n \"media\": \n [\n {\n \"image\": \n {\n \"id\": \"344592895_182127404391791_355010341914573594_n~mv2.jpeg\",\n \"url\": \"https://static.wixstatic.com/media/344592895_182127404391791_355010341914573594_n~mv2.jpeg\",\n \"height\": 1976,\n \"width\": 1572,\n \"altText\": \"laptop.jpeg\",\n \"filename\": \"laptop.jpeg\"\n }\n }\n ],\n \"rating\": 4\n },\n \"createdDate\": \"2023-05-15T13:09:26.856Z\",\n \"updatedDate\": \"2023-05-15T13:09:27.270Z\",\n \"author\": \n {\n \"contactId\": \"453faee9-8e67-45f1-87dc-f247bdf3510e\",\n \"authorName\": \"Joey\"\n },\n \"reply\": \n {\n \"message\": \"Thanks!\",\n \"createdDate\": \"2023-07-10T09:31:06.700Z\",\n \"updatedDate\": \"2023-07-10T09:31:06.700Z\"\n },\n \"foundHelpful\": 0,\n \"foundUnhelpful\": 0,\n \"helpfulness\": 0,\n \"moderation\": \n {\n \"moderationStatus\": \"APPROVED\",\n \"manuallyChanged\": false\n },\n \"verified\": false,\n \"origin\": {\n \"type\": \"ORGANIC\"\n },\n \"publishCount\": 1\n }\n}"}},{"name":"GetReview","type":"METHOD","order":1,"content":{"title":"Get Review","description":"Gets a review. Returns review whether published or not.","request":"curl GET \\\n 'https://www.wixapis.com/reviews/v1/reviews/605c64b4-d40c-4d53-a777-015209763905?returnPrivateReviews=true' \\\n -H 'Content-Type: application/json;charset=UTF-8' \\\n -H 'Authorization: '","response":"{\n \"review\": \n {\n \"id\": \"605c64b4-d40c-4d53-a777-015209763905\",\n \"revision\": \"1\",\n \"namespace\": \"stores\",\n \"entityId\": \"df19c1f7-07d8-a265-42f8-e8dfa824cc6e\",\n \"content\": \n {\n \"title\": \"Excellent Laptop with Great Features\",\n \"body\": \"This laptop excels in speed, battery life, display quality, and is great for both work and gaming.\",\n \"media\": \n [\n {\n \"image\": \n {\n \"id\": \"344592895_182127404391791_355010341914573594_n~mv2.jpg\",\n \"url\": \"https://static.wixstatic.com/media/344592895_182127404391791_355010341914573594_n~mv2.jpg\",\n \"height\": 1976,\n \"width\": 1572,\n \"altText\": \"laptop.jpeg\",\n \"filename\": \"laptop.jpeg\"\n }\n }\n ],\n \"rating\": 4\n },\n \"createdDate\": \"2023-05-15T13:09:26.856Z\",\n \"updatedDate\": \"2023-05-15T13:09:27.270Z\",\n \"author\": \n {\n \"contactId\": \"453faee9-8e67-45f1-87dc-f247bdf3510e\",\n \"authorName\": \"Joey\"\n },\n \"reply\": \n {\n \"message\": \"Thanks!\",\n \"createdDate\": \"2023-07-10T09:31:06.700Z\",\n \"updatedDate\": \"2023-07-10T09:31:06.700Z\"\n },\n \"foundHelpful\": 0,\n \"foundUnhelpful\": 0,\n \"helpfulness\": 0,\n \"moderation\": \n {\n \"moderationStatus\": \"IN_MODERATION\",\n \"manuallyChanged\": false\n },\n \"verified\": false,\n \"origin\": {\n \"type\": \"ORGANIC\"\n },\n \"publishCount\": 0\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git"},"httpMethod":"get","path":"/v1/reviews/{reviewId}","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.critique.reviews.Reviews","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["REVIEWS.READ_REVIEWS","REVIEWS.READ_PRIVATE_REVIEWS"],"applicableIdentities":["APP","MEMBER","VISITOR"],"externalPermissionScopes":[{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Read reviews","scopeId":"SCOPE.DC-REVIEWS.READ-REVIEWS"},{"name":"Manage Reviews","scopeId":"SCOPE.DC-REVIEWS.MANAGE-REVIEWS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"name":"Manage Reviews","scopeId":"SCOPE.DC-REVIEWS.MANAGE-REVIEWS"}],"protoArtifactId":"com.wixpress.critique:reviews","serviceArtifactId":"com.wixpress.critique.reviews","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.critique.reviews.GetReviewRequest","responseMessage":"com.wixpress.critique.reviews.GetReviewResponse"},"legacyExamples":[{"name":"GetReview","type":"METHOD","content":{"title":"Get Published Review","description":"Gets a review. Returns review only if published.","request":"curl GET \\\n 'https://www.wixapis.com/reviews/v1/reviews/605c64b4-d40c-4d53-a777-015209763905' \\\n -H 'Content-Type: application/json;charset=UTF-8' \\\n -H 'Authorization: '","response":"{\n \"review\": \n {\n \"id\": \"605c64b4-d40c-4d53-a777-015209763905\",\n \"revision\": \"1\",\n \"namespace\": \"stores\",\n \"entityId\": \"df19c1f7-07d8-a265-42f8-e8dfa824cc6e\",\n \"content\": \n {\n \"title\": \"Excellent Laptop with Great Features\",\n \"body\": \"This laptop excels in speed, battery life, display quality, and is great for both work and gaming.\",\n \"media\": \n [\n {\n \"image\": \n {\n \"id\": \"344592895_182127404391791_355010341914573594_n~mv2.jpeg\",\n \"url\": \"https://static.wixstatic.com/media/344592895_182127404391791_355010341914573594_n~mv2.jpeg\",\n \"height\": 1976,\n \"width\": 1572,\n \"altText\": \"laptop.jpeg\",\n \"filename\": \"laptop.jpeg\"\n }\n }\n ],\n \"rating\": 4\n },\n \"createdDate\": \"2023-05-15T13:09:26.856Z\",\n \"updatedDate\": \"2023-05-15T13:09:27.270Z\",\n \"author\": \n {\n \"contactId\": \"453faee9-8e67-45f1-87dc-f247bdf3510e\",\n \"authorName\": \"Joey\"\n },\n \"reply\": \n {\n \"message\": \"Thanks!\",\n \"createdDate\": \"2023-07-10T09:31:06.700Z\",\n \"updatedDate\": \"2023-07-10T09:31:06.700Z\"\n },\n \"foundHelpful\": 0,\n \"foundUnhelpful\": 0,\n \"helpfulness\": 0,\n \"moderation\": \n {\n \"moderationStatus\": \"APPROVED\",\n \"manuallyChanged\": false\n },\n \"verified\": false,\n \"origin\": {\n \"type\": \"ORGANIC\"\n },\n \"publishCount\": 1\n }\n}"}},{"name":"GetReview","type":"METHOD","order":1,"content":{"title":"Get Review","description":"Gets a review. Returns review whether published or not.","request":"curl GET \\\n 'https://www.wixapis.com/reviews/v1/reviews/605c64b4-d40c-4d53-a777-015209763905?returnPrivateReviews=true' \\\n -H 'Content-Type: application/json;charset=UTF-8' \\\n -H 'Authorization: '","response":"{\n \"review\": \n {\n \"id\": \"605c64b4-d40c-4d53-a777-015209763905\",\n \"revision\": \"1\",\n \"namespace\": \"stores\",\n \"entityId\": \"df19c1f7-07d8-a265-42f8-e8dfa824cc6e\",\n \"content\": \n {\n \"title\": \"Excellent Laptop with Great Features\",\n \"body\": \"This laptop excels in speed, battery life, display quality, and is great for both work and gaming.\",\n \"media\": \n [\n {\n \"image\": \n {\n \"id\": \"344592895_182127404391791_355010341914573594_n~mv2.jpg\",\n \"url\": \"https://static.wixstatic.com/media/344592895_182127404391791_355010341914573594_n~mv2.jpg\",\n \"height\": 1976,\n \"width\": 1572,\n \"altText\": \"laptop.jpeg\",\n \"filename\": \"laptop.jpeg\"\n }\n }\n ],\n \"rating\": 4\n },\n \"createdDate\": \"2023-05-15T13:09:26.856Z\",\n \"updatedDate\": \"2023-05-15T13:09:27.270Z\",\n \"author\": \n {\n \"contactId\": \"453faee9-8e67-45f1-87dc-f247bdf3510e\",\n \"authorName\": \"Joey\"\n },\n \"reply\": \n {\n \"message\": \"Thanks!\",\n \"createdDate\": \"2023-07-10T09:31:06.700Z\",\n \"updatedDate\": \"2023-07-10T09:31:06.700Z\"\n },\n \"foundHelpful\": 0,\n \"foundUnhelpful\": 0,\n \"helpfulness\": 0,\n \"moderation\": \n {\n \"moderationStatus\": \"IN_MODERATION\",\n \"manuallyChanged\": false\n },\n \"verified\": false,\n \"origin\": {\n \"type\": \"ORGANIC\"\n },\n \"publishCount\": 0\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git","contentLink":{"displayName":"Get Review","slugifiedName":"get-review"},"permissionScopes":[{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Manage Reviews","scopeId":"SCOPE.DC-REVIEWS.MANAGE-REVIEWS"},{"name":"Read reviews","scopeId":"SCOPE.DC-REVIEWS.READ-REVIEWS"},{"name":"Manage Portfolio","scopeId":"SCOPE.PORTFOLIO.MANAGE-PORTFOLIO"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"name":"Manage Reviews","scopeId":"SCOPE.DC-REVIEWS.MANAGE-REVIEWS"}],"isAdminMethod":false},{"summary":"Delete Review","description":"Deletes a review by ID.","operationId":"com.wixpress.critique.reviews.Reviews.DeleteReview","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"reviewId","description":"Review ID.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.critique.reviews.DeleteReviewResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/reviews/v1/reviews","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/reviews/v1/reviews","destinationPath":"/v1/reviews","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[{"title":"Review Deleted","description":"Triggered when a review is deleted.","permissions":["REVIEWS.READ_PRIVATE_REVIEWS"],"exposure":"PUBLIC","maturity":"BETA","slug":"deleted","eventTopic":"domain_events_wix.reviews.v1.review","serviceName":"com.wixpress.critique.reviews.Reviews","domainEvent":"DELETED","externalPermissionScopes":[],"eventType":"wix.reviews.v1.review_deleted","sourceRepo":"git@github.com:wix-private/app-market.git"}],"serviceName":"com.wixpress.critique.reviews.Reviews","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["REVIEWS.DELETE_REVIEW"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Reviews","scopeId":"SCOPE.DC-REVIEWS.MANAGE-REVIEWS"}],"protoArtifactId":"com.wixpress.critique:reviews","serviceArtifactId":"com.wixpress.critique.reviews","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.critique.reviews.DeleteReviewRequest","responseMessage":"com.wixpress.critique.reviews.DeleteReviewResponse"},"legacyExamples":[{"name":"DeleteReview","type":"METHOD","content":{"title":"Delete Review","request":"curl DELETE \\\n 'https://www.wixapis.com/reviews/v1/reviews/605c64b4-d40c-4d53-a777-015209763905' \\\n -H 'Content-Type: application/json;charset=UTF-8' \\\n -H 'Authorization: '","response":"{\n \"review\": \n {\n \"id\": \"605c64b4-d40c-4d53-a777-015209763905\",\n \"revision\": \"1\",\n \"namespace\": \"stores\",\n \"entityId\": \"df19c1f7-07d8-a265-42f8-e8dfa824cc6e\",\n \"content\": \n {\n \"title\": \"Excellent Laptop with Great Features\",\n \"body\": \"This laptop excels in speed, battery life, display quality, and is great for both work and gaming.\",\n \"media\": \n [ \n { \n \"image\": \n { \n \"id\": \"344592895_182127404391791_355010341914573594_n~mv2.jpeg\",\n \"url\": \"https://static.wixstatic.com/media/344592895_182127404391791_355010341914573594_n~mv2.jpeg\",\n \"height\": 1976,\n \"width\": 1572,\n \"altText\": \"laptop.jpeg\",\n \"filename\": \"laptop.jpeg\"\n }\n }\n ],\n \"rating\": 4\n },\n \"createdDate\": \"2023-05-15T13:09:26.856Z\",\n \"updatedDate\": \"2023-05-15T13:09:27.270Z\",\n \"author\": \n { \n \"contactId\": \"453faee9-8e67-45f1-87dc-f247bdf3510e\",\n },\n \"foundHelpful\": 0,\n \"foundUnhelpful\": 0,\n \"helpfulness\": 0,\n \"moderation\": \n { \n \"moderationStatus\": \"APPROVED\",\n \"manuallyChanged\": false\n },\n \"verified\": false,\n \"origin\": {\n \"type\": \"ORGANIC\"\n },\n \"publishCount\": 1\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git"},"httpMethod":"delete","path":"/v1/reviews/{reviewId}","rpcOnly":false,"triggeredEvents":[{"title":"Review Deleted","description":"Triggered when a review is deleted.","permissions":["REVIEWS.READ_PRIVATE_REVIEWS"],"exposure":"PUBLIC","maturity":"BETA","slug":"deleted","eventTopic":"domain_events_wix.reviews.v1.review","serviceName":"com.wixpress.critique.reviews.Reviews","domainEvent":"DELETED","externalPermissionScopes":[],"eventType":"wix.reviews.v1.review_deleted","sourceRepo":"git@github.com:wix-private/app-market.git"}],"serviceName":"com.wixpress.critique.reviews.Reviews","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["REVIEWS.DELETE_REVIEW"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Reviews","scopeId":"SCOPE.DC-REVIEWS.MANAGE-REVIEWS"}],"protoArtifactId":"com.wixpress.critique:reviews","serviceArtifactId":"com.wixpress.critique.reviews","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.critique.reviews.DeleteReviewRequest","responseMessage":"com.wixpress.critique.reviews.DeleteReviewResponse"},"legacyExamples":[{"name":"DeleteReview","type":"METHOD","content":{"title":"Delete Review","request":"curl DELETE \\\n 'https://www.wixapis.com/reviews/v1/reviews/605c64b4-d40c-4d53-a777-015209763905' \\\n -H 'Content-Type: application/json;charset=UTF-8' \\\n -H 'Authorization: '","response":"{\n \"review\": \n {\n \"id\": \"605c64b4-d40c-4d53-a777-015209763905\",\n \"revision\": \"1\",\n \"namespace\": \"stores\",\n \"entityId\": \"df19c1f7-07d8-a265-42f8-e8dfa824cc6e\",\n \"content\": \n {\n \"title\": \"Excellent Laptop with Great Features\",\n \"body\": \"This laptop excels in speed, battery life, display quality, and is great for both work and gaming.\",\n \"media\": \n [ \n { \n \"image\": \n { \n \"id\": \"344592895_182127404391791_355010341914573594_n~mv2.jpeg\",\n \"url\": \"https://static.wixstatic.com/media/344592895_182127404391791_355010341914573594_n~mv2.jpeg\",\n \"height\": 1976,\n \"width\": 1572,\n \"altText\": \"laptop.jpeg\",\n \"filename\": \"laptop.jpeg\"\n }\n }\n ],\n \"rating\": 4\n },\n \"createdDate\": \"2023-05-15T13:09:26.856Z\",\n \"updatedDate\": \"2023-05-15T13:09:27.270Z\",\n \"author\": \n { \n \"contactId\": \"453faee9-8e67-45f1-87dc-f247bdf3510e\",\n },\n \"foundHelpful\": 0,\n \"foundUnhelpful\": 0,\n \"helpfulness\": 0,\n \"moderation\": \n { \n \"moderationStatus\": \"APPROVED\",\n \"manuallyChanged\": false\n },\n \"verified\": false,\n \"origin\": {\n \"type\": \"ORGANIC\"\n },\n \"publishCount\": 1\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git","contentLink":{"displayName":"Delete Review","slugifiedName":"delete-review"},"permissionScopes":[{"name":"Manage Reviews","scopeId":"SCOPE.DC-REVIEWS.MANAGE-REVIEWS"}],"isAdminMethod":true},{"summary":"Create Review","description":"Creates a new review using a contact ID.\n\n\nThis endpoint requires a [`review.author.contactId`](https://dev.wix.com/api/rest/contacts).\nAfter a review is created, it may require [moderation](https://dev.wix.com/docs/rest/api-reference/wix-reviews/reviews/introduction#moderation).\n\nIf `authorName` is left empty, the [member's](https://dev.wix.com/docs/rest/api-reference/members/members/get-member) name will be used.\nIf the author is not a member, the field is left `null`.","operationId":"com.wixpress.critique.reviews.Reviews.CreateReview","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.critique.reviews.CreateReviewResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/reviews/v1/reviews","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/reviews/v1/reviews","destinationPath":"/v1/reviews","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"CreateReviewRequest","description":"","properties":{"review":{"description":"Review data.","$ref":"#/components/schemas/com.wixpress.critique.reviews.Review","summary":"review","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["review","review.namespace","review.entityId","review.content","review.author","review.author.contactId","review.content.rating"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Review Created","description":"Triggered when a review is created.","permissions":["REVIEWS.READ_PRIVATE_REVIEWS"],"exposure":"PUBLIC","maturity":"BETA","slug":"created","eventTopic":"domain_events_wix.reviews.v1.review","serviceName":"com.wixpress.critique.reviews.Reviews","domainEvent":"CREATED","externalPermissionScopes":[],"eventType":"wix.reviews.v1.review_created","sourceRepo":"git@github.com:wix-private/app-market.git"},{"title":"Review Review Published","description":"Triggered when moderation status is set to APPROVED.","permissions":["REVIEWS.READ_PRIVATE_REVIEWS"],"payload":{"schemaName":"com.wixpress.critique.reviews.ReviewPublished"},"exposure":"PUBLIC","maturity":"BETA","slug":"review_published","eventTopic":"domain_events_wix.reviews.v1.review","serviceName":"com.wixpress.critique.reviews.Reviews","domainEvent":"CUSTOM_ACTION","externalPermissionScopes":[],"eventType":"wix.reviews.v1.review_review_published","sourceRepo":"git@github.com:wix-private/app-market.git"}],"serviceName":"com.wixpress.critique.reviews.Reviews","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["REVIEWS.CREATE_REVIEW"],"applicableIdentities":["APP","MEMBER","VISITOR"],"externalPermissionScopes":[{"name":"Manage Reviews","scopeId":"SCOPE.DC-REVIEWS.MANAGE-REVIEWS"}],"protoArtifactId":"com.wixpress.critique:reviews","serviceArtifactId":"com.wixpress.critique.reviews","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.critique.reviews.CreateReviewRequest","responseMessage":"com.wixpress.critique.reviews.CreateReviewResponse"},"legacyExamples":[{"name":"CreateReview","type":"METHOD","content":{"title":"Create Review","description":"Creates a review and rating for an entity","request":"curl POST \\\n 'https://www.wixapis.com/reviews/v1/reviews' \\\n -H 'Content-Type: application/json;charset=UTF-8' \\\n -H 'Authorization: ' \\\n -d '{\n \"review\": \n {\n \"namespace\": \"stores\",\n \"entityId\": \"df19c1f7-07d8-a265-42f8-e8dfa824cc6e\",\n \"content\": \n {\n \"title\": \"Excellent Laptop with Great Features\",\n \"body\": \"This laptop excels in speed, battery life, display quality, and is great for both work and gaming.\",\n \"media\": \n [\n {\n \"image\": \n {\n \"id\": \"344592895_182127404391791_355010341914573594_n~mv2.jpeg\"\n }\n }\n ],\n \"rating\": 4\n },\n \"author\": \n {\n \"contactId\": \"453faee9-8e67-45f1-87dc-f247bdf3510e\",\n \"authorName\": \"Joey\"\n }\n }\n }'","response":"{\n \"review\": \n {\n \"id\": \"605c64b4-d40c-4d53-a777-015209763905\",\n \"revision\": \"1\",\n \"namespace\": \"stores\",\n \"entityId\": \"df19c1f7-07d8-a265-42f8-e8dfa824cc6e\",\n \"content\": \n {\n \"title\": \"Excellent Laptop with Great Features\",\n \"body\": \"This laptop excels in speed, battery life, display quality, and is great for both work and gaming.\",\n \"media\": \n [ \n { \n \"image\": \n { \n \"id\": \"344592895_182127404391791_355010341914573594_n~mv2.jpeg\",\n \"url\": \"https://static.wixstatic.com/media/344592895_182127404391791_355010341914573594_n~mv2.jpeg\",\n \"height\": 1976,\n \"width\": 1572,\n \"altText\": \"laptop.jpeg\",\n \"filename\": \"laptop.jpeg\"\n }\n }\n ],\n \"rating\": 4\n },\n \"createdDate\": \"2023-05-15T13:09:26.856Z\",\n \"updatedDate\": \"2023-05-15T13:09:27.270Z\",\n \"author\": \n { \n \"contactId\": \"453faee9-8e67-45f1-87dc-f247bdf3510e\",\n \"authorName\": \"Joey\"\n },\n \"foundHelpful\": 0,\n \"foundUnhelpful\": 0,\n \"helpfulness\": 0,\n \"moderation\": \n { \n \"moderationStatus\": \"IN_MODERATION\",\n \"manuallyChanged\": false\n },\n \"verified\": false,\n \"origin\": {\n \"type\": \"ORGANIC\"\n },\n \"publishCount\": 0\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git"},"httpMethod":"post","path":"/v1/reviews","rpcOnly":false,"triggeredEvents":[{"title":"Review Created","description":"Triggered when a review is created.","permissions":["REVIEWS.READ_PRIVATE_REVIEWS"],"exposure":"PUBLIC","maturity":"BETA","slug":"created","eventTopic":"domain_events_wix.reviews.v1.review","serviceName":"com.wixpress.critique.reviews.Reviews","domainEvent":"CREATED","externalPermissionScopes":[],"eventType":"wix.reviews.v1.review_created","sourceRepo":"git@github.com:wix-private/app-market.git"},{"title":"Review Review Published","description":"Triggered when moderation status is set to APPROVED.","permissions":["REVIEWS.READ_PRIVATE_REVIEWS"],"payload":{"schemaName":"com.wixpress.critique.reviews.ReviewPublished"},"exposure":"PUBLIC","maturity":"BETA","slug":"review_published","eventTopic":"domain_events_wix.reviews.v1.review","serviceName":"com.wixpress.critique.reviews.Reviews","domainEvent":"CUSTOM_ACTION","externalPermissionScopes":[],"eventType":"wix.reviews.v1.review_review_published","sourceRepo":"git@github.com:wix-private/app-market.git"}],"serviceName":"com.wixpress.critique.reviews.Reviews","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["REVIEWS.CREATE_REVIEW"],"applicableIdentities":["APP","MEMBER","VISITOR"],"externalPermissionScopes":[{"name":"Manage Reviews","scopeId":"SCOPE.DC-REVIEWS.MANAGE-REVIEWS"}],"protoArtifactId":"com.wixpress.critique:reviews","serviceArtifactId":"com.wixpress.critique.reviews","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.critique.reviews.CreateReviewRequest","responseMessage":"com.wixpress.critique.reviews.CreateReviewResponse"},"legacyExamples":[{"name":"CreateReview","type":"METHOD","content":{"title":"Create Review","description":"Creates a review and rating for an entity","request":"curl POST \\\n 'https://www.wixapis.com/reviews/v1/reviews' \\\n -H 'Content-Type: application/json;charset=UTF-8' \\\n -H 'Authorization: ' \\\n -d '{\n \"review\": \n {\n \"namespace\": \"stores\",\n \"entityId\": \"df19c1f7-07d8-a265-42f8-e8dfa824cc6e\",\n \"content\": \n {\n \"title\": \"Excellent Laptop with Great Features\",\n \"body\": \"This laptop excels in speed, battery life, display quality, and is great for both work and gaming.\",\n \"media\": \n [\n {\n \"image\": \n {\n \"id\": \"344592895_182127404391791_355010341914573594_n~mv2.jpeg\"\n }\n }\n ],\n \"rating\": 4\n },\n \"author\": \n {\n \"contactId\": \"453faee9-8e67-45f1-87dc-f247bdf3510e\",\n \"authorName\": \"Joey\"\n }\n }\n }'","response":"{\n \"review\": \n {\n \"id\": \"605c64b4-d40c-4d53-a777-015209763905\",\n \"revision\": \"1\",\n \"namespace\": \"stores\",\n \"entityId\": \"df19c1f7-07d8-a265-42f8-e8dfa824cc6e\",\n \"content\": \n {\n \"title\": \"Excellent Laptop with Great Features\",\n \"body\": \"This laptop excels in speed, battery life, display quality, and is great for both work and gaming.\",\n \"media\": \n [ \n { \n \"image\": \n { \n \"id\": \"344592895_182127404391791_355010341914573594_n~mv2.jpeg\",\n \"url\": \"https://static.wixstatic.com/media/344592895_182127404391791_355010341914573594_n~mv2.jpeg\",\n \"height\": 1976,\n \"width\": 1572,\n \"altText\": \"laptop.jpeg\",\n \"filename\": \"laptop.jpeg\"\n }\n }\n ],\n \"rating\": 4\n },\n \"createdDate\": \"2023-05-15T13:09:26.856Z\",\n \"updatedDate\": \"2023-05-15T13:09:27.270Z\",\n \"author\": \n { \n \"contactId\": \"453faee9-8e67-45f1-87dc-f247bdf3510e\",\n \"authorName\": \"Joey\"\n },\n \"foundHelpful\": 0,\n \"foundUnhelpful\": 0,\n \"helpfulness\": 0,\n \"moderation\": \n { \n \"moderationStatus\": \"IN_MODERATION\",\n \"manuallyChanged\": false\n },\n \"verified\": false,\n \"origin\": {\n \"type\": \"ORGANIC\"\n },\n \"publishCount\": 0\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git","contentLink":{"displayName":"Create Review","slugifiedName":"create-review"},"permissionScopes":[{"name":"Manage Reviews","scopeId":"SCOPE.DC-REVIEWS.MANAGE-REVIEWS"}],"isAdminMethod":false},{"summary":"Update Review","description":"Updates a review.\n\n\nEach time the review is updated, `revision` increments by 1. The existing `revision` must be included\nwhen updating the review. This ensures you're working with the latest review information, and it prevents unintended overwrites.","operationId":"com.wixpress.critique.reviews.Reviews.UpdateReview","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"review.id","description":"Review ID.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.critique.reviews.UpdateReviewResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/reviews/v1/reviews","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/reviews/v1/reviews","destinationPath":"/v1/reviews","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"UpdateReviewRequest","description":"","properties":{"review":{"description":"Review to update.","$ref":"#/components/schemas/com.wixpress.critique.reviews.Review","summary":"review","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["review.id","review.revision"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Review Updated","description":"Triggered when a review is updated.","permissions":["REVIEWS.READ_PRIVATE_REVIEWS"],"exposure":"PUBLIC","maturity":"BETA","slug":"updated","eventTopic":"domain_events_wix.reviews.v1.review","serviceName":"com.wixpress.critique.reviews.Reviews","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.reviews.v1.review_updated","sourceRepo":"git@github.com:wix-private/app-market.git"},{"title":"Review Moderation Status Changed","description":"Triggered when moderation status is changed or a review is created.","permissions":["REVIEWS.READ_PRIVATE_REVIEWS"],"payload":{"schemaName":"com.wixpress.critique.reviews.ModerationStatusChanged"},"exposure":"PUBLIC","maturity":"BETA","slug":"moderation_status_changed","eventTopic":"domain_events_wix.reviews.v1.review","serviceName":"com.wixpress.critique.reviews.Reviews","domainEvent":"CUSTOM_ACTION","externalPermissionScopes":[],"eventType":"wix.reviews.v1.review_moderation_status_changed","sourceRepo":"git@github.com:wix-private/app-market.git"},{"title":"Review Review Published","description":"Triggered when moderation status is set to APPROVED.","permissions":["REVIEWS.READ_PRIVATE_REVIEWS"],"payload":{"schemaName":"com.wixpress.critique.reviews.ReviewPublished"},"exposure":"PUBLIC","maturity":"BETA","slug":"review_published","eventTopic":"domain_events_wix.reviews.v1.review","serviceName":"com.wixpress.critique.reviews.Reviews","domainEvent":"CUSTOM_ACTION","externalPermissionScopes":[],"eventType":"wix.reviews.v1.review_review_published","sourceRepo":"git@github.com:wix-private/app-market.git"}],"serviceName":"com.wixpress.critique.reviews.Reviews","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["REVIEWS.UPDATE_REVIEW"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Reviews","scopeId":"SCOPE.DC-REVIEWS.MANAGE-REVIEWS"}],"protoArtifactId":"com.wixpress.critique:reviews","serviceArtifactId":"com.wixpress.critique.reviews","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.critique.reviews.UpdateReviewRequest","responseMessage":"com.wixpress.critique.reviews.UpdateReviewResponse"},"legacyExamples":[{"name":"UpdateReview","type":"METHOD","content":{"title":"Update Review","description":"Updates only the given fields (`revision` and `rating`)","request":"curl -X PATCH \\\n 'https://www.wixapis.com/reviews/v1/reviews/605c64b4-d40c-4d53-a777-015209763905' \\\n -H 'Content-Type: application/json;charset=UTF-8' \\\n -H 'Authorization: ' \\\n -d '{\n \"review\":\n {\n \"revision\": 1,\n \"content\":\n {\n \"rating\": 5\n }\n }\n }'","response":"{\n \"review\":\n {\n \"id\": \"605c64b4-d40c-4d53-a777-015209763905\",\n \"revision\": 2,\n \"namespace\": \"stores\",\n \"entityId\": \"df19c1f7-07d8-a265-42f8-e8dfa824cc6e\",\n \"content\":\n {\n \"title\": \"Excellent Laptop with Great Features\",\n \"body\": \"This laptop excels in speed, battery life, display quality, and is great for both work and gaming.\",\n \"media\":\n [\n {\n \"image\":\n {\n \"id\": \"344592895_182127404391791_355010341914573594_n~mv2.jpeg\",\n \"url\": \"https://static.wixstatic.com/media/344592895_182127404391791_355010341914573594_n~mv2.jpg\",\n \"height\": 1976,\n \"width\": 1572,\n \"altText\": \"laptop.jpeg\",\n \"filename\": \"laptop.jpeg\"\n }\n }\n ],\n \"rating\": 5\n },\n \"createdDate\": \"2023-05-15T13:09:26.856Z\",\n \"updatedDate\": \"2023-05-15T13:09:27.270Z\",\n \"author\":\n {\n \"contactId\": \"453faee9-8e67-45f1-87dc-f247bdf3510e\",\n \"authorName\": \"Joey\"\n },\n \"reply\":\n {\n \"message\": \"Thanks!\",\n \"createdDate\": \"2023-07-10T09:31:06.700Z\",\n \"updatedDate\": \"2023-07-10T09:31:06.700Z\"\n },\n \"foundHelpful\": 0,\n \"foundUnhelpful\": 0,\n \"helpfulness\": 0,\n \"moderation\":\n {\n \"moderationStatus\": \"APPROVED\",\n \"manuallyChanged\": false\n },\n \"verified\": false,\n \"origin\": {\n \"type\": \"ORGANIC\"\n },\n \"publishCount\": 1\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git"},"httpMethod":"patch","path":"/v1/reviews/{review.id}","rpcOnly":false,"triggeredEvents":[{"title":"Review Updated","description":"Triggered when a review is updated.","permissions":["REVIEWS.READ_PRIVATE_REVIEWS"],"exposure":"PUBLIC","maturity":"BETA","slug":"updated","eventTopic":"domain_events_wix.reviews.v1.review","serviceName":"com.wixpress.critique.reviews.Reviews","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.reviews.v1.review_updated","sourceRepo":"git@github.com:wix-private/app-market.git"},{"title":"Review Moderation Status Changed","description":"Triggered when moderation status is changed or a review is created.","permissions":["REVIEWS.READ_PRIVATE_REVIEWS"],"payload":{"schemaName":"com.wixpress.critique.reviews.ModerationStatusChanged"},"exposure":"PUBLIC","maturity":"BETA","slug":"moderation_status_changed","eventTopic":"domain_events_wix.reviews.v1.review","serviceName":"com.wixpress.critique.reviews.Reviews","domainEvent":"CUSTOM_ACTION","externalPermissionScopes":[],"eventType":"wix.reviews.v1.review_moderation_status_changed","sourceRepo":"git@github.com:wix-private/app-market.git"},{"title":"Review Review Published","description":"Triggered when moderation status is set to APPROVED.","permissions":["REVIEWS.READ_PRIVATE_REVIEWS"],"payload":{"schemaName":"com.wixpress.critique.reviews.ReviewPublished"},"exposure":"PUBLIC","maturity":"BETA","slug":"review_published","eventTopic":"domain_events_wix.reviews.v1.review","serviceName":"com.wixpress.critique.reviews.Reviews","domainEvent":"CUSTOM_ACTION","externalPermissionScopes":[],"eventType":"wix.reviews.v1.review_review_published","sourceRepo":"git@github.com:wix-private/app-market.git"}],"serviceName":"com.wixpress.critique.reviews.Reviews","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["REVIEWS.UPDATE_REVIEW"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Reviews","scopeId":"SCOPE.DC-REVIEWS.MANAGE-REVIEWS"}],"protoArtifactId":"com.wixpress.critique:reviews","serviceArtifactId":"com.wixpress.critique.reviews","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.critique.reviews.UpdateReviewRequest","responseMessage":"com.wixpress.critique.reviews.UpdateReviewResponse"},"legacyExamples":[{"name":"UpdateReview","type":"METHOD","content":{"title":"Update Review","description":"Updates only the given fields (`revision` and `rating`)","request":"curl -X PATCH \\\n 'https://www.wixapis.com/reviews/v1/reviews/605c64b4-d40c-4d53-a777-015209763905' \\\n -H 'Content-Type: application/json;charset=UTF-8' \\\n -H 'Authorization: ' \\\n -d '{\n \"review\":\n {\n \"revision\": 1,\n \"content\":\n {\n \"rating\": 5\n }\n }\n }'","response":"{\n \"review\":\n {\n \"id\": \"605c64b4-d40c-4d53-a777-015209763905\",\n \"revision\": 2,\n \"namespace\": \"stores\",\n \"entityId\": \"df19c1f7-07d8-a265-42f8-e8dfa824cc6e\",\n \"content\":\n {\n \"title\": \"Excellent Laptop with Great Features\",\n \"body\": \"This laptop excels in speed, battery life, display quality, and is great for both work and gaming.\",\n \"media\":\n [\n {\n \"image\":\n {\n \"id\": \"344592895_182127404391791_355010341914573594_n~mv2.jpeg\",\n \"url\": \"https://static.wixstatic.com/media/344592895_182127404391791_355010341914573594_n~mv2.jpg\",\n \"height\": 1976,\n \"width\": 1572,\n \"altText\": \"laptop.jpeg\",\n \"filename\": \"laptop.jpeg\"\n }\n }\n ],\n \"rating\": 5\n },\n \"createdDate\": \"2023-05-15T13:09:26.856Z\",\n \"updatedDate\": \"2023-05-15T13:09:27.270Z\",\n \"author\":\n {\n \"contactId\": \"453faee9-8e67-45f1-87dc-f247bdf3510e\",\n \"authorName\": \"Joey\"\n },\n \"reply\":\n {\n \"message\": \"Thanks!\",\n \"createdDate\": \"2023-07-10T09:31:06.700Z\",\n \"updatedDate\": \"2023-07-10T09:31:06.700Z\"\n },\n \"foundHelpful\": 0,\n \"foundUnhelpful\": 0,\n \"helpfulness\": 0,\n \"moderation\":\n {\n \"moderationStatus\": \"APPROVED\",\n \"manuallyChanged\": false\n },\n \"verified\": false,\n \"origin\": {\n \"type\": \"ORGANIC\"\n },\n \"publishCount\": 1\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git","contentLink":{"displayName":"Update Review","slugifiedName":"update-review"},"permissionScopes":[{"name":"Manage Reviews","scopeId":"SCOPE.DC-REVIEWS.MANAGE-REVIEWS"}],"isAdminMethod":true},{"summary":"Query Reviews","description":"Retrieves a list of reviews, given the provided paging, filtering, and sorting.\n100 reviews can be returned per request.\n\nQuery Reviews runs with these defaults, which you can override:\n\n- `createdDate` is sorted in `ASC` order\n- `paging.limit` is `100`\n\nFor field support for filters and sorting, see\n[Reviews: Supported Filters and Sorting](https://dev.wix.com/docs/rest/api-reference/wix-reviews/reviews/sort-and-filter).\nTo learn about working with _Query_ endpoints, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).","operationId":"com.wixpress.critique.reviews.Reviews.QueryReviews","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.critique.reviews.QueryReviewsResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/reviews/v1/reviews","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/reviews/v1/reviews","destinationPath":"/v1/reviews","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"QueryReviewsRequest","description":"","properties":{"query":{"description":"Review query.","$ref":"#/components/schemas/com.wixpress.critique.reviews.upstream.wix.common.QueryV2","summary":"query","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"returnPrivateReviews":{"description":"Whether to return private (unpublished) reviews.\n\nDefault: `false`","title":"returnPrivateReviews","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.critique.reviews.Reviews","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["REVIEWS.READ_REVIEWS","REVIEWS.READ_PRIVATE_REVIEWS"],"applicableIdentities":["APP","MEMBER","VISITOR"],"externalPermissionScopes":[{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Read reviews","scopeId":"SCOPE.DC-REVIEWS.READ-REVIEWS"},{"name":"Manage Reviews","scopeId":"SCOPE.DC-REVIEWS.MANAGE-REVIEWS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"name":"Manage Reviews","scopeId":"SCOPE.DC-REVIEWS.MANAGE-REVIEWS"}],"protoArtifactId":"com.wixpress.critique:reviews","serviceArtifactId":"com.wixpress.critique.reviews","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.critique.reviews.QueryReviewsRequest","responseMessage":"com.wixpress.critique.reviews.QueryReviewsResponse"},"legacyExamples":[{"name":"QueryReviews","type":"METHOD","content":{"title":"Query Reviews with a namespace filter","request":"curl POST \\\n 'https://www.wixapis.com/reviews/v1/reviews/query' \\\n -H 'Content-Type: application/json;charset=UTF-8' \\\n -H 'Authorization: ' \\\n -d '{\n \"query\": \n {\n \"filter\": \n {\n \"namespace\": \"stores\"\n }\n }\n }'","response":"{\n \"reviews\": \n [\n {\n \"id\": \"605c64b4-d40c-4d53-a777-015209763905\",\n \"revision\": \"1\",\n \"namespace\": \"stores\",\n \"entityId\": \"df19c1f7-07d8-a265-42f8-e8dfa824cc6e\",\n \"content\": \n {\n \"title\": \"Excellent Laptop with Great Features\",\n \"body\": \"This laptop excels in speed, battery life, display quality, and is great for both work and gaming.\",\n \"media\": \n [ \n { \n \"image\": \n { \n \"id\": \"344592895_182127404391791_355010341914573594_n~mv2.jpeg\",\n \"url\": \"https://static.wixstatic.com/media/344592895_182127404391791_355010341914573594_n~mv2.jpeg\",\n \"height\": 1976,\n \"width\": 1572,\n \"altText\": \"laptop.jpeg\",\n \"filename\": \"laptop.jpeg\"\n }\n }\n ],\n \"rating\": 4\n },\n \"createdDate\": \"2023-05-15T13:09:26.856Z\",\n \"updatedDate\": \"2023-05-15T13:09:27.270Z\",\n \"author\": \n { \n \"contactId\": \"453faee9-8e67-45f1-87dc-f247bdf3510e\",\n \"authorName\": \"Joey\"\n },\n \"reply\": \n {\n \"message\": \"Thanks!\",\n \"createdDate\": \"2023-07-10T09:31:06.700Z\",\n \"updatedDate\": \"2023-07-10T09:31:06.700Z\"\n },\n \"foundHelpful\": 0,\n \"foundUnhelpful\": 0,\n \"helpfulness\": 0,\n \"moderation\": \n { \n \"moderationStatus\": \"APPROVED\",\n \"manuallyChanged\": false\n },\n \"verified\": false,\n \"origin\": {\n \"type\": \"ORGANIC\"\n },\n \"publishCount\": 1\n }\n ]\n}"}},{"name":"QueryReviews","type":"METHOD","order":1,"content":{"title":"Query Reviews","description":"Retrieves private (unpublished) reviews with `stores` namespace","request":"curl POST \\\n 'https://www.wixapis.com/reviews/v1/reviews/query?returnPrivateReviews=true' \\\n -H 'Content-Type: application/json;charset=UTF-8' \\\n -H 'Authorization: ' \\\n -d '{\n \"query\": \n {\n \"filter\": \n {\n \"namespace\": \"stores\"\n }\n }\n }'","response":"{\n \"reviews\": \n [\n {\n \"id\": \"605c64b4-d40c-4d53-a777-015209763905\",\n \"revision\": \"1\",\n \"namespace\": \"stores\",\n \"entityId\": \"df19c1f7-07d8-a265-42f8-e8dfa824cc6e\",\n \"content\": \n {\n \"title\": \"Excellent Laptop with Great Features\",\n \"body\": \"This laptop excels in speed, battery life, display quality, and is great for both work and gaming.\",\n \"media\": \n [ \n { \n \"image\": \n { \n \"id\": \"344592895_182127404391791_355010341914573594_n~mv2.jpeg\",\n \"url\": \"https://static.wixstatic.com/media/344592895_182127404391791_355010341914573594_n~mv2.jpeg\",\n \"height\": 1976,\n \"width\": 1572,\n \"altText\": \"laptop.jpeg\",\n \"filename\": \"laptop.jpeg\"\n }\n }\n ],\n \"rating\": 4\n },\n \"createdDate\": \"2023-05-15T13:09:26.856Z\",\n \"updatedDate\": \"2023-05-15T13:09:27.270Z\",\n \"author\": \n { \n \"contactId\": \"453faee9-8e67-45f1-87dc-f247bdf3510e\",\n \"authorName\": \"Joey\"\n },\n \"reply\": \n {\n \"message\": \"Thanks!\",\n \"createdDate\": \"2023-07-10T09:31:06.700Z\",\n \"updatedDate\": \"2023-07-10T09:31:06.700Z\"\n },\n \"foundHelpful\": 0,\n \"foundUnhelpful\": 0,\n \"helpfulness\": 0,\n \"moderation\": \n { \n \"moderationStatus\": \"REJECTED\",\n \"manuallyChanged\": false\n },\n \"verified\": false,\n \"origin\": {\n \"type\": \"ORGANIC\"\n },\n \"publishCount\": 0\n }\n ]\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git"},"httpMethod":"post","path":"/v1/reviews/query","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.critique.reviews.Reviews","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["REVIEWS.READ_REVIEWS","REVIEWS.READ_PRIVATE_REVIEWS"],"applicableIdentities":["APP","MEMBER","VISITOR"],"externalPermissionScopes":[{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Read reviews","scopeId":"SCOPE.DC-REVIEWS.READ-REVIEWS"},{"name":"Manage Reviews","scopeId":"SCOPE.DC-REVIEWS.MANAGE-REVIEWS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"name":"Manage Reviews","scopeId":"SCOPE.DC-REVIEWS.MANAGE-REVIEWS"}],"protoArtifactId":"com.wixpress.critique:reviews","serviceArtifactId":"com.wixpress.critique.reviews","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.critique.reviews.QueryReviewsRequest","responseMessage":"com.wixpress.critique.reviews.QueryReviewsResponse"},"legacyExamples":[{"name":"QueryReviews","type":"METHOD","content":{"title":"Query Reviews with a namespace filter","request":"curl POST \\\n 'https://www.wixapis.com/reviews/v1/reviews/query' \\\n -H 'Content-Type: application/json;charset=UTF-8' \\\n -H 'Authorization: ' \\\n -d '{\n \"query\": \n {\n \"filter\": \n {\n \"namespace\": \"stores\"\n }\n }\n }'","response":"{\n \"reviews\": \n [\n {\n \"id\": \"605c64b4-d40c-4d53-a777-015209763905\",\n \"revision\": \"1\",\n \"namespace\": \"stores\",\n \"entityId\": \"df19c1f7-07d8-a265-42f8-e8dfa824cc6e\",\n \"content\": \n {\n \"title\": \"Excellent Laptop with Great Features\",\n \"body\": \"This laptop excels in speed, battery life, display quality, and is great for both work and gaming.\",\n \"media\": \n [ \n { \n \"image\": \n { \n \"id\": \"344592895_182127404391791_355010341914573594_n~mv2.jpeg\",\n \"url\": \"https://static.wixstatic.com/media/344592895_182127404391791_355010341914573594_n~mv2.jpeg\",\n \"height\": 1976,\n \"width\": 1572,\n \"altText\": \"laptop.jpeg\",\n \"filename\": \"laptop.jpeg\"\n }\n }\n ],\n \"rating\": 4\n },\n \"createdDate\": \"2023-05-15T13:09:26.856Z\",\n \"updatedDate\": \"2023-05-15T13:09:27.270Z\",\n \"author\": \n { \n \"contactId\": \"453faee9-8e67-45f1-87dc-f247bdf3510e\",\n \"authorName\": \"Joey\"\n },\n \"reply\": \n {\n \"message\": \"Thanks!\",\n \"createdDate\": \"2023-07-10T09:31:06.700Z\",\n \"updatedDate\": \"2023-07-10T09:31:06.700Z\"\n },\n \"foundHelpful\": 0,\n \"foundUnhelpful\": 0,\n \"helpfulness\": 0,\n \"moderation\": \n { \n \"moderationStatus\": \"APPROVED\",\n \"manuallyChanged\": false\n },\n \"verified\": false,\n \"origin\": {\n \"type\": \"ORGANIC\"\n },\n \"publishCount\": 1\n }\n ]\n}"}},{"name":"QueryReviews","type":"METHOD","order":1,"content":{"title":"Query Reviews","description":"Retrieves private (unpublished) reviews with `stores` namespace","request":"curl POST \\\n 'https://www.wixapis.com/reviews/v1/reviews/query?returnPrivateReviews=true' \\\n -H 'Content-Type: application/json;charset=UTF-8' \\\n -H 'Authorization: ' \\\n -d '{\n \"query\": \n {\n \"filter\": \n {\n \"namespace\": \"stores\"\n }\n }\n }'","response":"{\n \"reviews\": \n [\n {\n \"id\": \"605c64b4-d40c-4d53-a777-015209763905\",\n \"revision\": \"1\",\n \"namespace\": \"stores\",\n \"entityId\": \"df19c1f7-07d8-a265-42f8-e8dfa824cc6e\",\n \"content\": \n {\n \"title\": \"Excellent Laptop with Great Features\",\n \"body\": \"This laptop excels in speed, battery life, display quality, and is great for both work and gaming.\",\n \"media\": \n [ \n { \n \"image\": \n { \n \"id\": \"344592895_182127404391791_355010341914573594_n~mv2.jpeg\",\n \"url\": \"https://static.wixstatic.com/media/344592895_182127404391791_355010341914573594_n~mv2.jpeg\",\n \"height\": 1976,\n \"width\": 1572,\n \"altText\": \"laptop.jpeg\",\n \"filename\": \"laptop.jpeg\"\n }\n }\n ],\n \"rating\": 4\n },\n \"createdDate\": \"2023-05-15T13:09:26.856Z\",\n \"updatedDate\": \"2023-05-15T13:09:27.270Z\",\n \"author\": \n { \n \"contactId\": \"453faee9-8e67-45f1-87dc-f247bdf3510e\",\n \"authorName\": \"Joey\"\n },\n \"reply\": \n {\n \"message\": \"Thanks!\",\n \"createdDate\": \"2023-07-10T09:31:06.700Z\",\n \"updatedDate\": \"2023-07-10T09:31:06.700Z\"\n },\n \"foundHelpful\": 0,\n \"foundUnhelpful\": 0,\n \"helpfulness\": 0,\n \"moderation\": \n { \n \"moderationStatus\": \"REJECTED\",\n \"manuallyChanged\": false\n },\n \"verified\": false,\n \"origin\": {\n \"type\": \"ORGANIC\"\n },\n \"publishCount\": 0\n }\n ]\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git","contentLink":{"displayName":"Query Reviews","slugifiedName":"query-reviews"},"permissionScopes":[{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Manage Reviews","scopeId":"SCOPE.DC-REVIEWS.MANAGE-REVIEWS"},{"name":"Read reviews","scopeId":"SCOPE.DC-REVIEWS.READ-REVIEWS"},{"name":"Manage Portfolio","scopeId":"SCOPE.PORTFOLIO.MANAGE-PORTFOLIO"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"name":"Manage Reviews","scopeId":"SCOPE.DC-REVIEWS.MANAGE-REVIEWS"}],"isAdminMethod":false}],"webhooks":[{"summary":"Review Updated","title":"Review Updated","description":"","permissions":["REVIEWS.READ_PRIVATE_REVIEWS"],"exposure":"PUBLIC","maturity":"BETA","slug":"updated","eventTopic":"domain_events_wix.reviews.v1.review","serviceName":"com.wixpress.critique.reviews.EventHandlerService","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.reviews.v1.review_updated","legacyExamples":[{"name":"ReviewUpdated","eventType":"UPDATED","type":"DOMAIN_EVENT","content":"{\n \"id\": \"0ec75a41-ae29-4e5e-8063-46f5a5d925d9\",\n \"entityFqdn\": \"wix.reviews.v1.review\",\n \"slug\": \"updated\",\n \"entityId\": \"605c64b4-d40c-4d53-a777-015209763905\",\n \"updatedEvent\": \n {\n \"currentEntity\": \n {\n \"id\": \"605c64b4-d40c-4d53-a777-015209763905\",\n \"revision\": \"1\",\n \"namespace\": \"stores\",\n \"entityId\": \"df19c1f7-07d8-a265-42f8-e8dfa824cc6e\",\n \"content\": \n {\n \"title\": \"Excellent Laptop with Great Features\",\n \"body\": \"This laptop excels in speed, battery life, display quality, and is great for both work and gaming.\",\n \"media\": \n [ \n { \n \"image\": \n { \n \"id\": \"344592895_182127404391791_355010341914573594_n~mv2.jpeg\",\n \"url\": \"https://static.wixstatic.com/media/344592895_182127404391791_355010341914573594_n~mv2.jpeg\",\n \"height\": 1976,\n \"width\": 1572,\n \"altText\": \"laptop.jpge\",\n \"filename\": \"laptop.jpeg\"\n }\n }\n ],\n \"rating\": 4\n },\n \"createdDate\": \"2023-05-15T13:09:26.856Z\",\n \"updatedDate\": \"2023-05-15T13:09:27.270Z\",\n \"author\": \n { \n \"contactId\": \"453faee9-8e67-45f1-87dc-f247bdf3510e\",\n \"authorName\": \"Joey\"\n },\n \"foundHelpful\": 0,\n \"foundUnhelpful\": 0,\n \"helpfulness\": 0,\n \"moderation\": \n { \n \"moderationStatus\": \"APPROVED\",\n \"manuallyChanged\": false\n },\n \"verified\": false,\n \"origin\": {\n \"type\": \"ORGANIC\"\n },\n \"publishCount\": 1\n }\n },\n \"eventTime\": \"2023-05-15T13:10:26.856Z\",\n \"triggeredByAnonymizeRequest\":false\n}"}],"sourceRepo":"git@github.com:wix-private/app-market.git","$ref":"#/components/schemas/com.wixpress.critique.reviews.Review","contentLink":{"displayName":"Review Updated","slugifiedName":"review-updated"},"labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"permissionScopes":[{"name":"Manage Reviews","scopeId":"SCOPE.DC-REVIEWS.MANAGE-REVIEWS"}]},{"summary":"Review Created","title":"Review Created","description":"Triggered when a review is created.","permissions":["REVIEWS.READ_PRIVATE_REVIEWS"],"exposure":"PUBLIC","maturity":"BETA","slug":"created","eventTopic":"domain_events_wix.reviews.v1.review","serviceName":"com.wixpress.critique.reviews.Reviews","domainEvent":"CREATED","externalPermissionScopes":[{"name":"Manage Reviews","scopeId":"SCOPE.DC-REVIEWS.MANAGE-REVIEWS"}],"eventType":"wix.reviews.v1.review_created","legacyExamples":[{"name":"ReviewCreated","eventType":"CREATED","type":"DOMAIN_EVENT","content":"{\n \"id\": \"0ec75a41-ae29-4e5e-8063-46f5a5d925d9\",\n \"entityFqdn\": \"wix.reviews.v1.review\",\n \"slug\": \"created\",\n \"entityId\": \"605c64b4-d40c-4d53-a777-015209763905\",\n \"createdEvent\": \n {\n \"entity\": \n {\n \"id\": \"605c64b4-d40c-4d53-a777-015209763905\",\n \"revision\": \"1\",\n \"namespace\": \"stores\",\n \"entityId\": \"df19c1f7-07d8-a265-42f8-e8dfa824cc6e\",\n \"content\": \n {\n \"title\": \"Excellent Laptop with Great Features\",\n \"body\": \"This laptop excels in speed, battery life, display quality, and is great for both work and gaming.\",\n \"media\": \n [ \n { \n \"image\": \n { \n \"id\": \"344592895_182127404391791_355010341914573594_n~mv2.jpeg\",\n \"url\": \"https://static.wixstatic.com/media/344592895_182127404391791_355010341914573594_n~mv2.jpeg\",\n \"height\": 1976,\n \"width\": 1572,\n \"altText\": \"laptop.jpeg\",\n \"filename\": \"laptop.jpeg\"\n }\n }\n ],\n \"rating\": 4\n },\n \"createdDate\": \"2023-05-15T13:09:26.856Z\",\n \"updatedDate\": \"2023-05-15T13:09:27.270Z\",\n \"author\": \n { \n \"contactId\": \"453faee9-8e67-45f1-87dc-f247bdf3510e\",\n \"authorName\": \"Joey\"\n },\n \"foundHelpful\": 0,\n \"foundUnhelpful\": 0,\n \"helpfulness\": 0,\n \"moderation\": \n { \n \"moderationStatus\": \"APPROVED\",\n \"manuallyChanged\": false\n },\n \"verified\": false,\n \"origin\": {\n \"type\": \"ORGANIC\"\n },\n \"publishCount\": 1\n }\n },\n \"eventTime\": \"2023-05-15T13:09:26.856Z\",\n \"triggeredByAnonymizeRequest\": false\n}"}],"sourceRepo":"git@github.com:wix-private/app-market.git","$ref":"#/components/schemas/com.wixpress.critique.reviews.Review","contentLink":{"displayName":"Review Created","slugifiedName":"review-created"},"labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"permissionScopes":[{"name":"Manage Reviews","scopeId":"SCOPE.DC-REVIEWS.MANAGE-REVIEWS"}]},{"summary":"Review Published","title":"Review Review Published","description":"Triggered when moderation status is set to APPROVED.","permissions":["REVIEWS.READ_PRIVATE_REVIEWS"],"payload":{"schemaName":"com.wixpress.critique.reviews.ReviewPublished"},"exposure":"PUBLIC","maturity":"BETA","slug":"review_published","eventTopic":"domain_events_wix.reviews.v1.review","serviceName":"com.wixpress.critique.reviews.Reviews","domainEvent":"CUSTOM_ACTION","externalPermissionScopes":[{"name":"Manage Reviews","scopeId":"SCOPE.DC-REVIEWS.MANAGE-REVIEWS"}],"eventType":"wix.reviews.v1.review_review_published","legacyExamples":[{"name":"Review Published","type":"LEGACY_EVENT","content":"{\n \"id\": \"0ec75a41-ae29-4e5e-8063-46f5a5d925d9\",\n \"entityFqdn\": \"wix.reviews.v1.review\",\n \"slug\": \"review_published\",\n \"entityId\": \"605c64b4-d40c-4d53-a777-015209763905\",\n \"actionEvent\": \n {\n \"body\": \n {\n \"review\": \n {\n \"id\": \"605c64b4-d40c-4d53-a777-015209763905\",\n \"revision\": \"1\",\n \"namespace\": \"stores\",\n \"entityId\": \"df19c1f7-07d8-a265-42f8-e8dfa824cc6e\",\n \"content\": \n {\n \"title\": \"Excellent Laptop with Great Features\",\n \"body\": \"This laptop excels in speed, battery life, display quality, and is great for both work and gaming.\",\n \"media\": \n [ \n { \n \"image\": \n { \n \"id\": \"344592895_182127404391791_355010341914573594_n~mv2.jpeg\",\n \"url\": \"https://static.wixstatic.com/media/344592895_182127404391791_355010341914573594_n~mv2.jpeg\",\n \"height\": 1976,\n \"width\": 1572,\n \"altText\": \"laptop.jpeg\",\n \"filename\": \"laptop.jpeg\"\n }\n }\n ],\n \"rating\": 4\n },\n \"createdDate\": \"2023-05-15T13:09:26.856Z\",\n \"updatedDate\": \"2023-05-15T13:09:27.270Z\",\n \"author\": \n { \n \"contactId\": \"453faee9-8e67-45f1-87dc-f247bdf3510e\",\n \"authorName\": \"Joey\"\n },\n \"foundHelpful\": 0,\n \"foundUnhelpful\": 0,\n \"helpfulness\": 0,\n \"moderation\": \n { \n \"moderationStatus\": \"APPROVED\",\n \"manuallyChanged\": false\n },\n \"verified\": false,\n \"origin\": {\n \"type\": \"ORGANIC\"\n },\n \"publishCount\": 1\n }\n }\n },\n \"eventTime\": \"df19c1f7-07d8-a265-42f8-e8dfa824cc6e\",\n \"triggeredByAnonymizeRequest\":false\n}"}],"sourceRepo":"git@github.com:wix-private/app-market.git","$ref":"#/components/schemas/com.wixpress.critique.reviews.ReviewPublished","contentLink":{"displayName":"Review Published","slugifiedName":"review-published"},"labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"permissionScopes":[{"name":"Manage Reviews","scopeId":"SCOPE.DC-REVIEWS.MANAGE-REVIEWS"}]},{"summary":"Review Moderation Status Changed","title":"Review Moderation Status Changed","description":"","permissions":["REVIEWS.READ_PRIVATE_REVIEWS"],"payload":{"schemaName":"com.wixpress.critique.reviews.ModerationStatusChanged"},"exposure":"PUBLIC","maturity":"BETA","slug":"moderation_status_changed","eventTopic":"domain_events_wix.reviews.v1.review","serviceName":"com.wixpress.critique.reviews.Reviews","domainEvent":"CUSTOM_ACTION","externalPermissionScopes":[{"name":"Manage Reviews","scopeId":"SCOPE.DC-REVIEWS.MANAGE-REVIEWS"}],"eventType":"wix.reviews.v1.review_moderation_status_changed","legacyExamples":[{"name":"ModerationStatusChanged","eventType":"CHANGED","type":"DOMAIN_EVENT","content":"{\n \"id\": \"0ec75a41-ae29-4e5e-8063-46f5a5d925d9\",\n \"entityFqdn\": \"wix.reviews.v1.review\",\n \"slug\": \"moderation_status_changed\",\n \"entityId\": \"605c64b4-d40c-4d53-a777-015209763905\",\n \"actionEvent\": \n {\n \"body\": \n {\n \"review\": \n {\n \"id\": \"605c64b4-d40c-4d53-a777-015209763905\",\n \"revision\": \"1\",\n \"namespace\": \"stores\",\n \"entityId\": \"df19c1f7-07d8-a265-42f8-e8dfa824cc6e\",\n \"content\": \n {\n \"title\": \"Excellent Laptop with Great Features\",\n \"body\": \"This laptop excels in speed, battery life, display quality, and is great for both work and gaming.\",\n \"media\": \n [ \n { \n \"image\": \n { \n \"id\": \"344592895_182127404391791_355010341914573594_n~mv2.jpeg\",\n \"url\": \"https://static.wixstatic.com/media/344592895_182127404391791_355010341914573594_n~mv2.jpeg\",\n \"height\": 1976,\n \"width\": 1572,\n \"altText\": \"laptop.jpeg\",\n \"filename\": \"laptop.jpeg\"\n }\n }\n ],\n \"rating\": 4\n },\n \"createdDate\": \"2023-05-15T13:09:26.856Z\",\n \"updatedDate\": \"2023-05-15T13:09:27.270Z\",\n \"author\": \n { \n \"contactId\": \"453faee9-8e67-45f1-87dc-f247bdf3510e\",\n \"authorName\": \"Joey\"\n },\n \"foundHelpful\": 0,\n \"foundUnhelpful\": 0,\n \"helpfulness\": 0,\n \"moderation\": \n { \n \"moderationStatus\": \"APPROVED\",\n \"manuallyChanged\": false\n },\n \"verified\": false,\n \"origin\": {\n \"type\": \"ORGANIC\"\n }\n },\n \"previousModerationStatus\": \"SUBMITTED\",\n \"publishCount\": 0\n }\n },\n \"eventTime\": \"df19c1f7-07d8-a265-42f8-e8dfa824cc6e\",\n \"triggeredByAnonymizeRequest\":false\n}"}],"sourceRepo":"git@github.com:wix-private/app-market.git","$ref":"#/components/schemas/com.wixpress.critique.reviews.ModerationStatusChanged","contentLink":{"displayName":"Review Moderation Status Changed","slugifiedName":"review-moderation-status-changed"},"labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"permissionScopes":[{"name":"Manage Reviews","scopeId":"SCOPE.DC-REVIEWS.MANAGE-REVIEWS"}]},{"summary":"Review Deleted","title":"Review Deleted","description":"Triggered when a review is deleted.","permissions":["REVIEWS.READ_PRIVATE_REVIEWS"],"exposure":"PUBLIC","maturity":"BETA","slug":"deleted","eventTopic":"domain_events_wix.reviews.v1.review","serviceName":"com.wixpress.critique.reviews.Reviews","domainEvent":"DELETED","externalPermissionScopes":[{"name":"Manage Reviews","scopeId":"SCOPE.DC-REVIEWS.MANAGE-REVIEWS"}],"eventType":"wix.reviews.v1.review_deleted","legacyExamples":[{"name":"ReviewDeleted","eventType":"DELETED","type":"DOMAIN_EVENT","content":"{\n \"id\": \"0ec75a41-ae29-4e5e-8063-46f5a5d925d9\",\n \"entityFqdn\": \"wix.reviews.v1.review\",\n \"slug\": \"deleted\",\n \"entityId\": \"605c64b4-d40c-4d53-a777-015209763905\",\n \"eventTime\": \"2023-05-15T13:09:26.856Z\",\n \"triggeredByAnonymizeRequest\":false\n}"}],"sourceRepo":"git@github.com:wix-private/app-market.git","$ref":"#/components/schemas/com.wixpress.critique.reviews.Review","contentLink":{"displayName":"Review Deleted","slugifiedName":"review-deleted"},"labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"permissionScopes":[{"name":"Manage Reviews","scopeId":"SCOPE.DC-REVIEWS.MANAGE-REVIEWS"}]}],"articles":[{"displayName":"Introduction","slugifyName":"introduction","content":"# About the Reviews API\n\nWith the Reviews API you can manage reviews for a site's services, content, or products. The review object holds the content of the review, a rating score, images or video media, and information about the author. Learn more about [Wix Reviews](fallback::https://support.wix.com/en/article/wix-stores-adding-and-setting-up-wix-reviews).\n\nThe Wix Reviews API allows your app to:\n\n- Import reviews from other sites and export reviews to other sites.\n- Retrieve and display positive review data. Use the [Media API](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::c1a55f4c-8a6e-45b4-9f9c-8982c91f8a81*fallback::https://dev.wix.com/api/rest/media) to retrieve associated review media.\n- Retrieve negative review data enabling site owners to respond effectively.\n\n## Moderation\n\nIf moderation is turned on, reviews are checked for content that requires moderation. If moderation is required, the review remains pending until the site owner rejects or approves it in the site's [dashboard](fallback::https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Freviews/pending). \nThe site owner can configure moderation settings in the site's [dashboard](fallback::https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Freviews/settings/moderation). Learn more about [managing reviews](fallback::https://support.wix.com/en/article/wix-stores-managing-wix-reviews).\n\n## Before you begin\nIt’s important to note the following points before starting to code:\n\n- Every review needs a contact. To check whether a contact exists, your app can call the [Contacts API](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::874fc7dd-ac32-4d57-8b43-3166eff8f210slug::query-contacts*fallback::https://dev.wix.com/docs/rest/api-reference/contacts/contacts/contact-v4/query-contacts) with the author's email.\n- A review author is limited to one review per entity. Duplicate reviews receive an error response.\n- Replying to a review is available only in the site owner's [dashboard](fallback::https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Freviews/pending).\n\n## Use Cases\n- [Real-time 2-way sync with an eCommerce solution](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::2fe27377-f702-4993-a463-fcff15831a52slug::sample-flows#real-time-2-way-sync-with-an-ecommerce-solution*fallback::https://dev.wix.com/docs/rest/api-reference/wix-reviews/reviews/sample-flows#real-time-2-way-sync-with-an-ecommerce-solution).\n- [Display review media in a widget](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::2fe27377-f702-4993-a463-fcff15831a52slug::sample-flows#display-review-media-in-a-widget*fallback::https://dev.wix.com/docs/rest/api-reference/wix-reviews/reviews/sample-flows#display-review-media-in-a-widget).\n- [Get immediate updates of negative customer feedback](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::2fe27377-f702-4993-a463-fcff15831a52slug::sample-flows#get-immediate-updates-of-negative-customer-feedback*fallback::https://dev.wix.com/docs/rest/api-reference/wix-reviews/reviews/sample-flows#get-immediate-updates-of-negative-customer-feedback).\n- [Display the most helpful product reviews in a widget](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::2fe27377-f702-4993-a463-fcff15831a52slug::sample-flows#display-the-most-helpful-product-reviews-in-a-widget*fallback::https://dev.wix.com/docs/rest/api-reference/wix-reviews/reviews/sample-flows#display-the-most-helpful-product-reviews-in-a-widget).\n\n## Terminology\n\n- **Entity**: The entity to review. For example, a Wix Stores product. \n- **Namespace**: The Wix module that the Reviews API is integrated with. Currently only Wix Stores.\n- **Rating**: The rating score for the review item. An author can give a rating score between 1 and 5. The rating is displayed with the site review. \n- **Helpfulness**: Helpfulness is the overall helpfulness score calculated by subtracting Found Unhelpful from Found Helpful. Site visitors can indicate whether a review was helpful or not. \n- **Reply**: A direct reply to a review that was left on the site. The reply is displayed with the review. ","sourceRepo":"git@github.com:wix-private/app-market.git","path":"proto/appendices/docs/intro.md"},{"displayName":"Sample Flows","slugifyName":"sample-flows","content":"# Reviews: Sample Use Cases and Flows\n\nThis article shares some possible use cases your app can support. You are not limited to these use cases, but they can be a helpful jumping off point as you plan your app's implementation.\n\n## Real-time 2-way sync with an eCommerce solution\n\nSite owners can use your app to keep reviews from an eCommerce solution up to date with their reviews on Wix with a two-way sync. To synchronize Wix and the eCommerce solution, think about how your app will handle these flows:\n\n- Initial setup\n- Synchronize to the eCommerce solution\n- Synchronize to Wix\n\n### Initial setup\n\nCreate mappings for the following from the Wix site to the eCommerce solution using common fields so the reviews can be synced:\n- Wix site entities to entities in the eCommerce solution.\n- Wix site Contact IDs to author IDs in the eCommerce solution, for example using email addresses. \n- Wix review fields to the review fields in the eCommerce solution for example, title, body, author. \n\nStore the mappings on your app's server. Then follow these flows to create the two-way sync.\n\n### Synchronize to the eCommerce solution\n\nListen for a change in Wix reviews with the following webhooks:\n\n- [Review Created Webhook](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::2fe27377-f702-4993-a463-fcff15831a52slug::review-created*fallback::https://dev.wix.com/docs/rest/api-reference/wix-reviews/reviews/review-created).\n- [Review Updated Webhook](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::2fe27377-f702-4993-a463-fcff15831a52slug::review-updated*fallback::https://dev.wix.com/docs/rest/api-reference/wix-reviews/reviews/review-updated).\n- [Review Moderation Status Changed Webhook](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::2fe27377-f702-4993-a463-fcff15831a52slug::review-moderation-status-changed*fallback::https://dev.wix.com/docs/rest/api-reference/wix-reviews/reviews/review-moderation-status-changed).\n- [Review Deleted Webhook](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::2fe27377-f702-4993-a463-fcff15831a52slug::review-deleted*fallback::https://dev.wix.com/docs/rest/api-reference/wix-reviews/reviews/review-deleted).\n\nWhen one of the webhooks is triggered,\nyou'll receive the review in the payload.\nYou can send those changes to the eCommerce solution with a flow like this one:\n\n1. Get the `slug` (which tells you what the event was),\n `entityId` (ID of the review),\n and other relevant information from the payload data.\n\n2. Use the mappings from the [initial setup](fallback::#initial-setup)\n to send the relevant information to the eCommerce solution.\n\n3. Ignore the resulting event from the eCommerce solution\n so you don’t create an endless loop of updates.\n\n### Synchronize to Wix\n\nListen for review events from the eCommerce solution.\nWhen your app receives a change it needs to synchronize,\nfollow this basic flow:\n\n1. Use the [Contacts API](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::d8152734-5cd6-43e9-af7a-fcf7d9e5ea3b*fallback::https://dev.wix.com/api/rest/contacts) to check if the review author has a contact ID on the Wix site. \n\n2. The Reviews API allows only one review for each entity per contact. Use the mappings from the [initial setup](fallback::#initial-setup) to filter out imported reviews if there is already a Wix site review from the contact for the entity. \n \n3. Use the mappings from the [initial setup](fallback::#initial-setup) and call [Create Review](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::2fe27377-f702-4993-a463-fcff15831a52slug::create-review*fallback::https://dev.wix.com/docs/rest/api-reference/wix-reviews/reviews/create-review) if the author is a contact.\n\n4. Ignore the resulting event from Wix\n so you don’t create an endless loop of updates.\n\n## Display review media in a widget \n\n> **Note:** This flow requires Wix Blocks which is currently in Beta. \n\nTo enable a site owner to create a media gallery of photos from reviews, retrieve images from reviews and then display them in media layout.\n\n1. Use [Query Reviews](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::2fe27377-f702-4993-a463-fcff15831a52slug::query-reviews*fallback::https://dev.wix.com/docs/rest/api-reference/wix-reviews/reviews/query-reviews) to retrieve reviews that have media.\n\n2. Extract the `image.url` from the response and use the [Media API](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::439cd7bb-6c63-4fdb-a2f9-5996001fa883slug::import-file*fallback::https://dev.wix.com/docs/rest/api-reference/media/media-manager/files/import-file) to retrieve the media.\n\n3. Display the retrieved media items in gallery layout in a widget using Wix Blocks. Learn more about [Wix Blocks apps](fallback::https://support.wix.com/en/article/wix-blocks-design-guidelines-for-applications). \n\n## Get immediate updates of negative customer feedback\n\nTo enable a site owner to receive timely customer feedback, gain insights into product satisfaction, and identify areas for improvement, follow this basic flow.\n\n1. Listen for new reviews using the [Review Created Webhook](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::2fe27377-f702-4993-a463-fcff15831a52slug::review-created*fallback::https://dev.wix.com/docs/rest/api-reference/wix-reviews/reviews/review-created).\n\n2. Get the `entityId` (ID of the review), `content`, and any other relevant information from the payload data.\n\n3. Extract reviews from the payload that have `content.rating` less than 3. \n\n4. Provide the extracted review IDs to the site owner so they can reply in the Dashboard.\n\n## Display the most helpful product reviews in a widget\n\n> **Note:** This flow requires Wix Blocks which is currently in Beta. \n\nTo enable a site owner to display the most helpful reviews in order to promote products, follow this basic flow.\n\n1. Use [Query Reviews](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::2fe27377-f702-4993-a463-fcff15831a52slug::query-reviews*fallback::https://dev.wix.com/docs/rest/api-reference/wix-reviews/reviews/query-reviews) to get a list of the 10 most helpful reviews, sorted by most to least helpful.\n\n2. Display the retrieved reviews in a widget using Wix Blocks. Learn more about [Wix Blocks apps](fallback::https://support.wix.com/en/article/wix-blocks-design-guidelines-for-applications). \n\n","sourceRepo":"git@github.com:wix-private/app-market.git","path":"proto/appendices/docs/use-cases.md"},{"displayName":"Sort and Filter","slugifyName":"sort-and-filter","content":"# Reviews: Supported Filters and Sorting\n\nThe following table shows field support for filters and sorting for review properties:\n\n| Fields | Supported Filters | Sortable |\n| ----------- | ----------- | ----------- |\n| `id` | `$eq`, `$ne`, `$in` | |\n| `namespace` | `$eq`, `$ne`, `$in` | |\n| `entityId` | `$eq`, `$ne`, `$in` | |\n| `content.rating` | `$eq`, `$ne`, `$in`, `$lt`, `$lte`, `$gt`, `$gte` | Sortable |\n| `content.media` | `$isEmpty` | |\n| `helpfulness` | `$eq`, `$ne`, `$in`, `$lt`, `$lte`, `$gt`, `$gte` | Sortable |\n| `moderation.moderationStatus` | `$eq`, `$ne`, `$in` | |\n| `createdDate` | `$eq`, `$ne`, `$in`, `$lt`, `$lte`, `$gt`, `$gte` | Sortable |","sourceRepo":"git@github.com:wix-private/app-market.git","path":"proto/appendices/docs/sort-and-filter.md"}],"components":{"schemas":{"com.wixpress.critique.reviews.Review":{"type":"object","properties":{"namespace":{"description":"Review namespace. Currently integrated with Wix Stores, as `stores`.","title":"namespace","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"entityId":{"description":"ID of the entity to review. For example, a Wix Stores product ID.","maxLength":36,"title":"entityId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"id":{"description":"Review ID.","format":"GUID","readOnly":true,"title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"content":{"description":"Review content.","$ref":"#/components/schemas/com.wixpress.critique.reviews.ReviewContent","summary":"content","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"createdDate":{"description":"Date and time the review was created.","readOnly":true,"title":"createdDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"updatedDate":{"description":"Date and time the review was updated.","readOnly":true,"title":"updatedDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"author":{"description":"Author of the review.","immutable":true,"$ref":"#/components/schemas/com.wixpress.critique.reviews.Author","summary":"author","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"reply":{"description":"Reply to the review.","readOnly":true,"$ref":"#/components/schemas/com.wixpress.critique.reviews.Reply","summary":"reply","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"foundHelpful":{"description":"Number of site visitors who found the review helpful.","readOnly":true,"title":"foundHelpful","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"foundUnhelpful":{"description":"Number of site visitors who found the review unhelpful.","readOnly":true,"title":"foundUnhelpful","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"helpfulness":{"description":"Helpfulness score.\n\nCalculated by subtracting `foundUnhelpful` from `foundHelpful`.","readOnly":true,"title":"helpfulness","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"moderation":{"description":"Moderation status of the review.","readOnly":true,"$ref":"#/components/schemas/com.wixpress.critique.reviews.Moderation","summary":"moderation","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"revision":{"description":"Revision number, which increments by 1 each time the review is updated.\nTo prevent conflicting changes,\nthe current revision must be passed when updating the review.\nIgnored when creating a review.","readOnly":true,"title":"revision","type":"integer","format":"int64","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"verified":{"description":"Indicates whether the review has been verified through a Verify Product Purchase call to the Review Product catalog SPI.","readOnly":true,"title":"verified","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"origin":{"description":"Provides information about the origin of the review.\nOrganic reviews are created by site visitors or members.\nApp reviews are created by apps even though a site visitor or member is the author of the review.\nApps can not create or update organic reviews.","readOnly":true,"$ref":"#/components/schemas/com.wixpress.critique.reviews.Origin","summary":"origin","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"reviewDate":{"description":"Date and time when the review was written.\nThis should match `created_date`, except for reviews imported from another system.","title":"reviewDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"relevanceScore":{"description":"Platform-calculated score of review's relevance to the item. Used to sort\nreviews by relevance.","readOnly":true,"title":"relevanceScore","type":"number","format":"double","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"publishCount":{"description":"Counts the number of times a review has been published.\nReviews require approval before publishing, unless moderation is disabled.\nWhen moderation is disabled, reviews are automatically approved and published.","readOnly":true,"title":"publishCount","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Review","description":"A Review object includes all of the details related to the review of an entity. An entity is a specific resource to be reviewed,\nfor example, a store product.\nYou can manage existing reviews, create new reviews, and retrieve reviews.\nRead more about reviews in this [tutorial](https://support.wix.com/en/article/wix-stores-adding-and-setting-up-wix-reviews)."},"com.wixpress.critique.reviews.ReviewContent":{"type":"object","properties":{"title":{"description":"Review title.","maxLength":3000,"title":"title","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"body":{"description":"Review body.\n\nMax: 3,000 characters","maxLength":3000,"title":"body","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"media":{"description":"List of media items associated with the review.\n\nMax: 10 items","maxItems":10,"title":"media","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.critique.reviews.Media"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"rating":{"description":"Rating of the review.\n\nMin: `1`
\nMax: `5`","title":"rating","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ReviewContent","description":"The Review object."},"google.protobuf.StringValue":{"type":"object","properties":{"value":{"description":"","title":"value","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"StringValue","description":""},"com.wixpress.critique.reviews.Media":{"type":"object","properties":{},"title":"Media","description":"Media item associated with the review.","oneOf":[{"description":"","summary":"media","$ref":"#/components/schemas/com.wixpress.critique.reviews.Media.media"}]},"com.wixpress.critique.reviews.Media.media":{"type":"object","title":"media","properties":{"image":{"description":"Image media item.","$ref":"#/components/schemas/com.wixpress.critique.reviews.upstream.wix.common.Image","summary":"image","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"video":{"description":"Video media item.","$ref":"#/components/schemas/com.wixpress.critique.reviews.upstream.wix.common.VideoV2","summary":"video","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wixpress.critique.reviews.upstream.wix.common.Image":{"type":"object","properties":{"id":{"description":"WixMedia image ID.","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"url":{"description":"Image URL.","title":"url","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"height":{"description":"Original image height.","readOnly":true,"title":"height","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"width":{"description":"Original image width.","readOnly":true,"title":"width","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"altText":{"description":"Image alt text.","readOnly":true,"title":"altText","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"filename":{"description":"Image filename.","readOnly":true,"title":"filename","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Image","description":""},"com.wixpress.critique.reviews.upstream.wix.common.VideoV2":{"type":"object","properties":{"id":{"description":"WixMedia video ID.","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"resolutions":{"description":"Available resolutions for the video, starting with the optimal resolution.","readOnly":true,"title":"resolutions","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.critique.reviews.upstream.wix.common.VideoResolution"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"url":{"description":"Video URL.","title":"url","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"VideoV2","description":""},"com.wixpress.critique.reviews.upstream.wix.common.VideoResolution":{"type":"object","properties":{"url":{"description":"Video URL.","readOnly":true,"title":"url","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"height":{"description":"Video height.","readOnly":true,"title":"height","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"width":{"description":"Video width.","readOnly":true,"title":"width","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"poster":{"description":"Video thumbnail.","readOnly":true,"$ref":"#/components/schemas/com.wixpress.critique.reviews.upstream.wix.common.Image","summary":"poster","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"format":{"description":"Video format for example, mp4, hls.","readOnly":true,"title":"format","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"VideoResolution","description":""},"google.protobuf.Timestamp":{"type":"object","properties":{"seconds":{"description":"","title":"seconds","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"nanos":{"description":"","title":"nanos","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Timestamp","description":""},"com.wixpress.critique.reviews.Author":{"type":"object","properties":{"contactId":{"description":"Contact ID of the author.","format":"GUID","immutable":true,"title":"contactId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"authorName":{"description":"Display name of the author.","maxLength":100,"title":"authorName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Author","description":"Review author."},"com.wixpress.critique.reviews.Author.AuthorType":{"type":"string","description":"Supported types of review author.","title":"AuthorType","enum":["UNKNOWN","MEMBER","VISITOR"]},"com.wixpress.critique.reviews.Reply":{"type":"object","properties":{"message":{"description":"Reply content.","maxLength":1000,"title":"message","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"createdDate":{"description":"Date and time the reply was created.","readOnly":true,"title":"createdDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"updatedDate":{"description":"Date and time the reply was updated.","readOnly":true,"title":"updatedDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Reply","description":"Reply to the review."},"com.wixpress.critique.reviews.Moderation":{"type":"object","properties":{"moderationStatus":{"description":"- `APPROVED`: The review is approved and published.\n- `IN_MODERATION`: The review is pending moderation. Moderation can be applied in the site owner's [Dashboard](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Freviews/pending).\n- `REJECTED`: The review is rejected and not visible in the site.\n- `SUBMITTED`: Initial status of the review before the moderation process.","title":"moderationStatus","type":"string","$ref":"#/components/schemas/com.wixpress.critique.reviews.Moderation.ModerationStatus","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"manuallyChanged":{"description":"Indicates whether a moderator manually changed the `moderationStatus` of the review.\n\nIf the `moderationStatus` changed automatically because the review\npassed the moderation rules or if moderation is turned off, this field is set to `false`.","readOnly":true,"title":"manuallyChanged","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Moderation","description":"Moderation status of the review."},"com.wixpress.critique.reviews.Moderation.ModerationStatus":{"type":"string","description":"Supported states of the review.","title":"ModerationStatus","enum":["UNKNOWN","APPROVED","IN_MODERATION","REJECTED","SUBMITTED"]},"google.protobuf.Int64Value":{"type":"object","properties":{"value":{"description":"","title":"value","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Int64Value","description":""},"com.wixpress.critique.reviews.Origin":{"type":"object","properties":{"type":{"description":"The type of the review origin.","title":"type","type":"string","$ref":"#/components/schemas/com.wixpress.critique.reviews.Origin.OriginType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"appId":{"description":"The app ID of the APP review origin.\nSet only when the review origin is APP.","title":"appId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Origin","description":""},"com.wixpress.critique.reviews.Origin.OriginType":{"type":"string","description":"Supported types of review origin.","title":"OriginType","enum":["UNKNOWN","ORGANIC","APP"]},"google.protobuf.DoubleValue":{"type":"object","properties":{"value":{"description":"","title":"value","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DoubleValue","description":""},"wix.common.domainevents.DomainEvent":{"type":"object","properties":{"id":{"description":"Unique event ID.\nAllows clients to ignore duplicate webhooks.","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"entityFqdn":{"description":"Assumes actions are also always typed to an entity_type\nExample: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction","title":"entityFqdn","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"slug":{"description":"This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)\nThis is although the created/updated/deleted notion is duplication of the oneof types\nExample: created/updated/deleted/started/completed/email_opened","title":"slug","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"entityId":{"description":"ID of the entity associated with the event.","title":"entityId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"eventTime":{"description":"Event timestamp.","title":"eventTime","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"triggeredByAnonymizeRequest":{"description":"Whether the event was triggered as a result of a privacy regulation application\n(for example, GDPR).","title":"triggeredByAnonymizeRequest","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"originatedFrom":{"description":"If present, indicates the action that triggered the event.","title":"originatedFrom","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"entityEventSequence":{"description":"A sequence number defining the order of updates to the underlying entity.\nFor example, given that some entity was updated at 16:00 and than again at 16:01,\nit is guaranteed that the sequence number of the second update is strictly higher than the first.\nAs the consumer, you can use this value to ensure that you handle messages in the correct order.\nTo do so, you will need to persist this number on your end, and compare the sequence number from the\nmessage against the one you have stored. Given that the stored number is higher, you should ignore the message.","title":"entityEventSequence","type":"integer","format":"int64","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DomainEvent","description":"","oneOf":[{"description":"","summary":"body","$ref":"#/components/schemas/wix.common.domainevents.DomainEvent.body"}]},"wix.common.domainevents.DomainEvent.body":{"type":"object","title":"body","properties":{"createdEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.EntityCreatedEvent","summary":"createdEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"updatedEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.EntityUpdatedEvent","summary":"updatedEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"deletedEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.EntityDeletedEvent","summary":"deletedEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"actionEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.ActionEvent","summary":"actionEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"wix.common.domainevents.EntityCreatedEvent":{"type":"object","properties":{"entityAsJson":{"description":"","title":"entityAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EntityCreatedEvent","description":""},"google.protobuf.BoolValue":{"type":"object","properties":{"value":{"description":"","title":"value","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BoolValue","description":""},"wix.common.domainevents.UndeleteInfo":{"type":"object","properties":{"deletedDate":{"description":"","title":"deletedDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UndeleteInfo","description":""},"wix.common.domainevents.EntityUpdatedEvent":{"type":"object","properties":{"currentEntityAsJson":{"description":"Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\nThis means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\nWe don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.","title":"currentEntityAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EntityUpdatedEvent","description":""},"google.protobuf.Value":{"type":"object","properties":{},"title":"Value","description":"","oneOf":[{"description":"","summary":"kind","$ref":"#/components/schemas/google.protobuf.Value.kind"}]},"google.protobuf.Value.kind":{"type":"object","title":"kind","properties":{"nullValue":{"description":"","title":"nullValue","$ref":"#/components/schemas/google.protobuf.NullValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"numberValue":{"description":"","title":"numberValue","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"stringValue":{"description":"","title":"stringValue","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"boolValue":{"description":"","title":"boolValue","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"structValue":{"description":"","title":"structValue","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"listValue":{"description":"","title":"listValue","$ref":"#/components/schemas/google.protobuf.ListValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"google.protobuf.NullValue":{"type":"string","description":"","title":"NullValue","enum":["NULL_VALUE"]},"google.protobuf.Struct":{"type":"object","properties":{"fields":{"description":"","title":"fields","type":"object","format":"map","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/google.protobuf.Value"}},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Struct","description":""},"google.protobuf.ListValue":{"type":"object","properties":{"values":{"description":"","title":"values","type":"array","items":{"$ref":"#/components/schemas/google.protobuf.Value"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListValue","description":""},"wix.common.domainevents.EntityDeletedEvent":{"type":"object","properties":{"deletedEntityAsJson":{"description":"Entity that was deleted","title":"deletedEntityAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EntityDeletedEvent","description":""},"wix.common.domainevents.ActionEvent":{"type":"object","properties":{"bodyAsJson":{"description":"","title":"bodyAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ActionEvent","description":""},"google.protobuf.Empty":{"type":"object","properties":{},"title":"Empty","description":""},"com.wixpress.iptf.v1.webhooks.MessageEnvelope":{"type":"object","properties":{"instanceId":{"description":"App instance ID.","format":"GUID","title":"instanceId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"eventType":{"description":"Event type.","maxLength":150,"title":"eventType","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"identity":{"description":"The identification type and identity data.","$ref":"#/components/schemas/com.wixpress.iptf.v1.webhooks.IdentificationData","summary":"identity","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"data":{"description":"Stringify payload.","title":"data","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"MessageEnvelope","description":""},"com.wixpress.iptf.v1.webhooks.IdentificationData":{"type":"object","properties":{"identityType":{"description":"","readOnly":true,"title":"identityType","type":"string","$ref":"#/components/schemas/com.wixpress.iptf.v1.webhooks.IdentificationData.WebhookIdentityType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"IdentificationData","description":"","oneOf":[{"description":"","summary":"id","$ref":"#/components/schemas/com.wixpress.iptf.v1.webhooks.IdentificationData.id"}]},"com.wixpress.iptf.v1.webhooks.IdentificationData.id":{"type":"object","title":"id","properties":{"anonymousVisitorId":{"description":"ID of a site visitor that has not logged in to the site.","format":"GUID","title":"anonymousVisitorId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"memberId":{"description":"ID of a site visitor that has logged in to the site.","format":"GUID","title":"memberId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"wixUserId":{"description":"ID of a Wix user (site owner, contributor, etc.).","format":"GUID","title":"wixUserId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"appId":{"description":"ID of an app.","format":"GUID","title":"appId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wixpress.iptf.v1.webhooks.IdentificationData.WebhookIdentityType":{"type":"string","description":"","title":"WebhookIdentityType","enum":["UNKNOWN","ANONYMOUS_VISITOR","MEMBER","WIX_USER","APP"]},"com.wixpress.critique.reviews.GetReviewRequest":{"type":"object","properties":{"reviewId":{"description":"Review ID.","format":"GUID","title":"reviewId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"returnPrivateReviews":{"description":"Whether to return private (unpublished) reviews.\n\nDefault: `false`","title":"returnPrivateReviews","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetReviewRequest","description":""},"com.wixpress.critique.reviews.GetReviewResponse":{"type":"object","properties":{"review":{"description":"Review.","$ref":"#/components/schemas/com.wixpress.critique.reviews.Review","summary":"review","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetReviewResponse","description":""},"com.wixpress.critique.reviews.GetDeletedReviewRequest":{"type":"object","properties":{"reviewId":{"description":"Review ID.","format":"GUID","title":"reviewId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetDeletedReviewRequest","description":""},"com.wixpress.critique.reviews.GetDeletedReviewResponse":{"type":"object","properties":{"review":{"description":"Review.","$ref":"#/components/schemas/com.wixpress.critique.reviews.Review","summary":"review","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetDeletedReviewResponse","description":""},"com.wixpress.critique.reviews.CreateReviewAndContactRequest":{"type":"object","properties":{"namespace":{"description":"Namespace where the review is created.","maxLength":36,"title":"namespace","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"entityId":{"description":"ID of the entity to review.","maxLength":36,"title":"entityId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"name":{"description":"Name of the review author. Displayed as part of the review. Required for 3rd-party apps.","title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"email":{"description":"Email address of the review author. Required for 3rd-party apps.","format":"EMAIL","title":"email","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"content":{"description":"Review content.","$ref":"#/components/schemas/com.wixpress.critique.reviews.ReviewContent","summary":"content","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CreateReviewAndContactRequest","description":""},"com.wixpress.critique.reviews.CreateReviewResponse":{"type":"object","properties":{"review":{"description":"Created review.","$ref":"#/components/schemas/com.wixpress.critique.reviews.Review","summary":"review","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CreateReviewResponse","description":""},"com.wixpress.critique.reviews.CreateReviewRequest":{"type":"object","properties":{"review":{"description":"Review data.","$ref":"#/components/schemas/com.wixpress.critique.reviews.Review","summary":"review","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CreateReviewRequest","description":""},"com.wixpress.critique.reviews.ReviewPublished":{"type":"object","properties":{"review":{"description":"Review entity","$ref":"#/components/schemas/com.wixpress.critique.reviews.Review","summary":"review","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ReviewPublished","description":"Action describing changed review moderation status"},"com.wixpress.critique.reviews.BulkCreateReviewRequest":{"type":"object","properties":{"reviews":{"description":"Reviews to create.","minItems":1,"maxItems":100,"title":"reviews","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.critique.reviews.Review"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"returnEntity":{"description":"","title":"returnEntity","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkCreateReviewRequest","description":""},"com.wixpress.critique.reviews.BulkCreateReviewResponse":{"type":"object","properties":{"results":{"description":"Created reviews, only returned if returnEntity is set to true.\nItems are returned for successful operations and when returnEntity in the request is set to true.","title":"results","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.critique.reviews.BulkReviewResult"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"bulkActionMetadata":{"description":"","$ref":"#/components/schemas/wix.common.BulkActionMetadata","summary":"bulkActionMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkCreateReviewResponse","description":""},"com.wixpress.critique.reviews.BulkReviewResult":{"type":"object","properties":{"itemMetadata":{"description":"ItemMetadata","$ref":"#/components/schemas/wix.common.ItemMetadata","summary":"itemMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"review":{"description":"New Reviews","$ref":"#/components/schemas/com.wixpress.critique.reviews.Review","summary":"review","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkReviewResult","description":""},"wix.common.ItemMetadata":{"type":"object","properties":{"id":{"description":"Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"originalIndex":{"description":"Index of the item within the request array. Allows for correlation between request and response items.","title":"originalIndex","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"success":{"description":"Whether the requested action was successful for this item. When `false`, the `error` field is populated.","title":"success","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"error":{"description":"Details about the error in case of failure.","$ref":"#/components/schemas/wix.api.ApplicationError","summary":"error","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ItemMetadata","description":""},"wix.api.ApplicationError":{"type":"object","properties":{"code":{"description":"Error code.","title":"code","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"description":{"description":"Description of the error.","title":"description","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"data":{"description":"Data related to the error.","title":"data","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ApplicationError","description":""},"wix.common.BulkActionMetadata":{"type":"object","properties":{"totalSuccesses":{"description":"Number of items that were successfully processed.","title":"totalSuccesses","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"totalFailures":{"description":"Number of items that couldn't be processed.","title":"totalFailures","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"undetailedFailures":{"description":"Number of failures without details because detailed failure threshold was exceeded.","title":"undetailedFailures","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkActionMetadata","description":""},"com.wixpress.critique.reviews.UpdateReviewContentRequest":{"type":"object","properties":{"reviewId":{"description":"Review ID.","format":"GUID","title":"reviewId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"content":{"description":"Review content.","$ref":"#/components/schemas/com.wixpress.critique.reviews.ReviewContent","summary":"content","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UpdateReviewContentRequest","description":""},"google.protobuf.FieldMask":{"type":"object","properties":{"paths":{"description":"","title":"paths","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"FieldMask","description":""},"com.wixpress.critique.reviews.UpdateReviewContentResponse":{"type":"object","properties":{"review":{"description":"Updated review data.","$ref":"#/components/schemas/com.wixpress.critique.reviews.Review","summary":"review","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UpdateReviewContentResponse","description":""},"com.wixpress.critique.reviews.ModerationStatusChanged":{"type":"object","properties":{"review":{"description":"Review entity","$ref":"#/components/schemas/com.wixpress.critique.reviews.Review","summary":"review","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"previousModerationStatus":{"description":"The previous moderation status of the review.\n- `APPROVED`: The review is approved and published.\n- `IN_MODERATION`: The review is pending moderation. Moderation can be applied in the site owner's [Dashboard](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Freviews/pending).\n- `REJECTED`: The review is rejected and not visible in the site.\n- `SUBMITTED`: Initial status of the review before the moderation process.","title":"previousModerationStatus","type":"string","$ref":"#/components/schemas/com.wixpress.critique.reviews.Moderation.ModerationStatus","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ModerationStatusChanged","description":"Action describing changed review moderation status"},"com.wixpress.critique.reviews.UpdateReviewRequest":{"type":"object","properties":{"review":{"description":"Review to update.","$ref":"#/components/schemas/com.wixpress.critique.reviews.Review","summary":"review","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UpdateReviewRequest","description":""},"com.wixpress.critique.reviews.UpdateReviewResponse":{"type":"object","properties":{"review":{"description":"Updated review data.","$ref":"#/components/schemas/com.wixpress.critique.reviews.Review","summary":"review","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UpdateReviewResponse","description":""},"com.wixpress.critique.reviews.DeleteReviewRequest":{"type":"object","properties":{"reviewId":{"description":"Review ID.","format":"GUID","title":"reviewId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DeleteReviewRequest","description":""},"com.wixpress.critique.reviews.DeleteReviewResponse":{"type":"object","properties":{"review":{"description":"Review entity.","$ref":"#/components/schemas/com.wixpress.critique.reviews.Review","summary":"review","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DeleteReviewResponse","description":""},"com.wixpress.critique.reviews.BulkDeleteReviewsRequest":{"type":"object","properties":{"filter":{"description":"Filter object.\n\nPossible filters:\n`$eq`, `$gt`, `$gte`, `$in`, `$lt`, `$lte`, `$ne`.\n\nFor a detailed list of supported filters, see\nfiltering and sorting for\n[review properties](https://dev.wix.com/api/rest/reviews/sort-and-filter).\n\nExample:\n`{ \"filter\": { \"namespace\": \"$eq\": [\"stores\"] } }`","title":"filter","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkDeleteReviewsRequest","description":""},"com.wixpress.critique.reviews.BulkDeleteReviewsResponse":{"type":"object","properties":{"jobId":{"description":"Bulk job ID.","title":"jobId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkDeleteReviewsResponse","description":""},"com.wixpress.critique.reviews.QueryReviewsRequest":{"type":"object","properties":{"query":{"description":"Review query.","$ref":"#/components/schemas/com.wixpress.critique.reviews.upstream.wix.common.QueryV2","summary":"query","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"returnPrivateReviews":{"description":"Whether to return private (unpublished) reviews.\n\nDefault: `false`","title":"returnPrivateReviews","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"QueryReviewsRequest","description":""},"com.wixpress.critique.reviews.upstream.wix.common.QueryV2":{"type":"object","properties":{"filter":{"description":"Filter object. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more information.\nFor a detailed list of supported filters, see [Reviews: Supported Filters and Sorting](https://dev.wix.com/api/rest/reviews/sort-and-filter),","title":"filter","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"sort":{"description":"Sorting options. See [Reviews: Supported Filters and Sorting](https://dev.wix.com/api/rest/reviews/sort-and-filter) for more information,","title":"sort","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.critique.reviews.upstream.wix.common.Sorting"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"cursorPaging":{"description":"Cursor paging options.","$ref":"#/components/schemas/com.wixpress.critique.reviews.upstream.wix.common.CursorPaging","summary":"cursorPaging","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"QueryV2","description":""},"com.wixpress.critique.reviews.upstream.wix.common.Sorting":{"type":"object","properties":{"fieldName":{"description":"Name of the field to sort by.","title":"fieldName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"order":{"description":"Sort order.\n\nDefault: `ASC`.","title":"order","type":"string","$ref":"#/components/schemas/com.wixpress.critique.reviews.upstream.wix.common.SortOrder","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Sorting","description":"Sort options."},"com.wixpress.critique.reviews.upstream.wix.common.SortOrder":{"type":"string","description":"","title":"SortOrder","enum":["ASC","DESC"]},"com.wixpress.critique.reviews.upstream.wix.common.CursorPaging":{"type":"object","properties":{"limit":{"description":"The number of items to load.\nCursor token returned in the query response. To be used on the next query request, but not the first query request.\n\nMax: `100`
\nDefault: `50`","minimum":0,"maximum":100,"title":"limit","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"cursor":{"description":"Cursor returned in last query response. Should not be provided on first page request.","title":"cursor","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CursorPaging","description":""},"google.protobuf.Int32Value":{"type":"object","properties":{"value":{"description":"","title":"value","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Int32Value","description":""},"com.wixpress.critique.reviews.QueryReviewsResponse":{"type":"object","properties":{"metadata":{"description":"Paging metadata.","$ref":"#/components/schemas/com.wixpress.critique.reviews.upstream.wix.common.PagingMetadataV2","summary":"metadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"reviews":{"description":"List of returned reviews.","title":"reviews","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.critique.reviews.Review"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"QueryReviewsResponse","description":""},"com.wixpress.critique.reviews.upstream.wix.common.PagingMetadataV2":{"type":"object","properties":{"count":{"description":"Number of items returned in the response.","title":"count","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"offset":{"description":"Offset that was requested.","title":"offset","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"total":{"description":"Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set.","title":"total","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"tooManyToCount":{"description":"Flag that indicates the server failed to calculate the `total` field.","title":"tooManyToCount","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"cursors":{"description":"Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used.","$ref":"#/components/schemas/com.wixpress.critique.reviews.upstream.wix.common.Cursors","summary":"cursors","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PagingMetadataV2","description":""},"com.wixpress.critique.reviews.upstream.wix.common.Cursors":{"type":"object","properties":{"next":{"description":"Cursor pointing to next result page.","title":"next","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"prev":{"description":"Cursor pointing to previous result page.","title":"prev","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Cursors","description":""},"com.wixpress.critique.reviews.SetReplyRequest":{"type":"object","properties":{"reviewId":{"description":"Review id","format":"GUID","title":"reviewId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"message":{"description":"Response to review author","maxLength":10000,"title":"message","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SetReplyRequest","description":""},"com.wixpress.critique.reviews.SetReplyResponse":{"type":"object","properties":{"review":{"description":"Review entity","$ref":"#/components/schemas/com.wixpress.critique.reviews.Review","summary":"review","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SetReplyResponse","description":""},"com.wixpress.critique.reviews.RemoveReplyRequest":{"type":"object","properties":{"reviewId":{"description":"Review ID","format":"GUID","title":"reviewId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RemoveReplyRequest","description":""},"com.wixpress.critique.reviews.RemoveReplyResponse":{"type":"object","properties":{"review":{"description":"Review ID","$ref":"#/components/schemas/com.wixpress.critique.reviews.Review","summary":"review","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RemoveReplyResponse","description":""},"com.wixpress.critique.reviews.UpdateModerationStatusRequest":{"type":"object","properties":{"reviewId":{"description":"Review id","format":"GUID","title":"reviewId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"status":{"description":"Moderation status to set","title":"status","type":"string","$ref":"#/components/schemas/com.wixpress.critique.reviews.UpdateModerationStatusRequest.ModerationStatus","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UpdateModerationStatusRequest","description":""},"com.wixpress.critique.reviews.UpdateModerationStatusRequest.ModerationStatus":{"type":"string","description":"","title":"ModerationStatus","enum":["UNKNOWN_MODERATION_STATUS","APPROVED","REJECTED"]},"com.wixpress.critique.reviews.UpdateModerationStatusResponse":{"type":"object","properties":{"review":{"description":"Review entity","$ref":"#/components/schemas/com.wixpress.critique.reviews.Review","summary":"review","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UpdateModerationStatusResponse","description":""},"com.wixpress.critique.reviews.BulkUpdateModerationStatusRequest":{"type":"object","properties":{"filter":{"description":"Reviews to moderate","title":"filter","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"status":{"description":"Moderation status to set","title":"status","type":"string","$ref":"#/components/schemas/com.wixpress.critique.reviews.BulkUpdateModerationStatusRequest.ModerationStatus","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkUpdateModerationStatusRequest","description":""},"com.wixpress.critique.reviews.BulkUpdateModerationStatusRequest.ModerationStatus":{"type":"string","description":"","title":"ModerationStatus","enum":["UNKNOWN","APPROVED","REJECTED"]},"com.wixpress.critique.reviews.BulkUpdateModerationStatusResponse":{"type":"object","properties":{"jobId":{"description":"Reference to async job","title":"jobId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkUpdateModerationStatusResponse","description":""},"com.wixpress.critique.reviews.CountReviewsRequest":{"type":"object","properties":{"filter":{"description":"","title":"filter","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"includePrivateReviews":{"description":"Whether to include private (unpublished) reviews in count results.\n\nDefault: `false`","title":"includePrivateReviews","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CountReviewsRequest","description":""},"com.wixpress.critique.reviews.CountReviewsResponse":{"type":"object","properties":{"count":{"description":"Number of reviews.","title":"count","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CountReviewsResponse","description":""}}},"title":"Review","description":"A Review object includes all of the details related to the review of an entity. An entity is a specific resource to be reviewed,\nfor example, a store product.\nYou can manage existing reviews, create new reviews, and retrieve reviews.\nRead more about reviews in this [tutorial](https://support.wix.com/en/article/wix-stores-adding-and-setting-up-wix-reviews).","fqdn":"wix.reviews.v1.review"},"articles":[{"displayName":"Introduction","slugifyName":"introduction","content":"# About the Reviews API\n\nWith the Reviews API you can manage reviews for a site's services, content, or products. The review object holds the content of the review, a rating score, images or video media, and information about the author. Learn more about [Wix Reviews](fallback::https://support.wix.com/en/article/wix-stores-adding-and-setting-up-wix-reviews).\n\nThe Wix Reviews API allows your app to:\n\n- Import reviews from other sites and export reviews to other sites.\n- Retrieve and display positive review data. Use the [Media API](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::c1a55f4c-8a6e-45b4-9f9c-8982c91f8a81*fallback::https://dev.wix.com/api/rest/media) to retrieve associated review media.\n- Retrieve negative review data enabling site owners to respond effectively.\n\n## Moderation\n\nIf moderation is turned on, reviews are checked for content that requires moderation. If moderation is required, the review remains pending until the site owner rejects or approves it in the site's [dashboard](fallback::https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Freviews/pending). \nThe site owner can configure moderation settings in the site's [dashboard](fallback::https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Freviews/settings/moderation). Learn more about [managing reviews](fallback::https://support.wix.com/en/article/wix-stores-managing-wix-reviews).\n\n## Before you begin\nIt’s important to note the following points before starting to code:\n\n- Every review needs a contact. To check whether a contact exists, your app can call the [Contacts API](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::874fc7dd-ac32-4d57-8b43-3166eff8f210slug::query-contacts*fallback::https://dev.wix.com/docs/rest/api-reference/contacts/contacts/contact-v4/query-contacts) with the author's email.\n- A review author is limited to one review per entity. Duplicate reviews receive an error response.\n- Replying to a review is available only in the site owner's [dashboard](fallback::https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Freviews/pending).\n\n## Use Cases\n- [Real-time 2-way sync with an eCommerce solution](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::2fe27377-f702-4993-a463-fcff15831a52slug::sample-flows#real-time-2-way-sync-with-an-ecommerce-solution*fallback::https://dev.wix.com/docs/rest/api-reference/wix-reviews/reviews/sample-flows#real-time-2-way-sync-with-an-ecommerce-solution).\n- [Display review media in a widget](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::2fe27377-f702-4993-a463-fcff15831a52slug::sample-flows#display-review-media-in-a-widget*fallback::https://dev.wix.com/docs/rest/api-reference/wix-reviews/reviews/sample-flows#display-review-media-in-a-widget).\n- [Get immediate updates of negative customer feedback](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::2fe27377-f702-4993-a463-fcff15831a52slug::sample-flows#get-immediate-updates-of-negative-customer-feedback*fallback::https://dev.wix.com/docs/rest/api-reference/wix-reviews/reviews/sample-flows#get-immediate-updates-of-negative-customer-feedback).\n- [Display the most helpful product reviews in a widget](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::2fe27377-f702-4993-a463-fcff15831a52slug::sample-flows#display-the-most-helpful-product-reviews-in-a-widget*fallback::https://dev.wix.com/docs/rest/api-reference/wix-reviews/reviews/sample-flows#display-the-most-helpful-product-reviews-in-a-widget).\n\n## Terminology\n\n- **Entity**: The entity to review. For example, a Wix Stores product. \n- **Namespace**: The Wix module that the Reviews API is integrated with. Currently only Wix Stores.\n- **Rating**: The rating score for the review item. An author can give a rating score between 1 and 5. The rating is displayed with the site review. \n- **Helpfulness**: Helpfulness is the overall helpfulness score calculated by subtracting Found Unhelpful from Found Helpful. Site visitors can indicate whether a review was helpful or not. \n- **Reply**: A direct reply to a review that was left on the site. The reply is displayed with the review. "},{"displayName":"Sample Flows","slugifyName":"sample-flows","content":"# Reviews: Sample Use Cases and Flows\n\nThis article shares some possible use cases your app can support. You are not limited to these use cases, but they can be a helpful jumping off point as you plan your app's implementation.\n\n## Real-time 2-way sync with an eCommerce solution\n\nSite owners can use your app to keep reviews from an eCommerce solution up to date with their reviews on Wix with a two-way sync. To synchronize Wix and the eCommerce solution, think about how your app will handle these flows:\n\n- Initial setup\n- Synchronize to the eCommerce solution\n- Synchronize to Wix\n\n### Initial setup\n\nCreate mappings for the following from the Wix site to the eCommerce solution using common fields so the reviews can be synced:\n- Wix site entities to entities in the eCommerce solution.\n- Wix site Contact IDs to author IDs in the eCommerce solution, for example using email addresses. \n- Wix review fields to the review fields in the eCommerce solution for example, title, body, author. \n\nStore the mappings on your app's server. Then follow these flows to create the two-way sync.\n\n### Synchronize to the eCommerce solution\n\nListen for a change in Wix reviews with the following webhooks:\n\n- [Review Created Webhook](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::2fe27377-f702-4993-a463-fcff15831a52slug::review-created*fallback::https://dev.wix.com/docs/rest/api-reference/wix-reviews/reviews/review-created).\n- [Review Updated Webhook](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::2fe27377-f702-4993-a463-fcff15831a52slug::review-updated*fallback::https://dev.wix.com/docs/rest/api-reference/wix-reviews/reviews/review-updated).\n- [Review Moderation Status Changed Webhook](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::2fe27377-f702-4993-a463-fcff15831a52slug::review-moderation-status-changed*fallback::https://dev.wix.com/docs/rest/api-reference/wix-reviews/reviews/review-moderation-status-changed).\n- [Review Deleted Webhook](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::2fe27377-f702-4993-a463-fcff15831a52slug::review-deleted*fallback::https://dev.wix.com/docs/rest/api-reference/wix-reviews/reviews/review-deleted).\n\nWhen one of the webhooks is triggered,\nyou'll receive the review in the payload.\nYou can send those changes to the eCommerce solution with a flow like this one:\n\n1. Get the `slug` (which tells you what the event was),\n `entityId` (ID of the review),\n and other relevant information from the payload data.\n\n2. Use the mappings from the [initial setup](fallback::#initial-setup)\n to send the relevant information to the eCommerce solution.\n\n3. Ignore the resulting event from the eCommerce solution\n so you don’t create an endless loop of updates.\n\n### Synchronize to Wix\n\nListen for review events from the eCommerce solution.\nWhen your app receives a change it needs to synchronize,\nfollow this basic flow:\n\n1. Use the [Contacts API](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::d8152734-5cd6-43e9-af7a-fcf7d9e5ea3b*fallback::https://dev.wix.com/api/rest/contacts) to check if the review author has a contact ID on the Wix site. \n\n2. The Reviews API allows only one review for each entity per contact. Use the mappings from the [initial setup](fallback::#initial-setup) to filter out imported reviews if there is already a Wix site review from the contact for the entity. \n \n3. Use the mappings from the [initial setup](fallback::#initial-setup) and call [Create Review](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::2fe27377-f702-4993-a463-fcff15831a52slug::create-review*fallback::https://dev.wix.com/docs/rest/api-reference/wix-reviews/reviews/create-review) if the author is a contact.\n\n4. Ignore the resulting event from Wix\n so you don’t create an endless loop of updates.\n\n## Display review media in a widget \n\n> **Note:** This flow requires Wix Blocks which is currently in Beta. \n\nTo enable a site owner to create a media gallery of photos from reviews, retrieve images from reviews and then display them in media layout.\n\n1. Use [Query Reviews](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::2fe27377-f702-4993-a463-fcff15831a52slug::query-reviews*fallback::https://dev.wix.com/docs/rest/api-reference/wix-reviews/reviews/query-reviews) to retrieve reviews that have media.\n\n2. Extract the `image.url` from the response and use the [Media API](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::439cd7bb-6c63-4fdb-a2f9-5996001fa883slug::import-file*fallback::https://dev.wix.com/docs/rest/api-reference/media/media-manager/files/import-file) to retrieve the media.\n\n3. Display the retrieved media items in gallery layout in a widget using Wix Blocks. Learn more about [Wix Blocks apps](fallback::https://support.wix.com/en/article/wix-blocks-design-guidelines-for-applications). \n\n## Get immediate updates of negative customer feedback\n\nTo enable a site owner to receive timely customer feedback, gain insights into product satisfaction, and identify areas for improvement, follow this basic flow.\n\n1. Listen for new reviews using the [Review Created Webhook](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::2fe27377-f702-4993-a463-fcff15831a52slug::review-created*fallback::https://dev.wix.com/docs/rest/api-reference/wix-reviews/reviews/review-created).\n\n2. Get the `entityId` (ID of the review), `content`, and any other relevant information from the payload data.\n\n3. Extract reviews from the payload that have `content.rating` less than 3. \n\n4. Provide the extracted review IDs to the site owner so they can reply in the Dashboard.\n\n## Display the most helpful product reviews in a widget\n\n> **Note:** This flow requires Wix Blocks which is currently in Beta. \n\nTo enable a site owner to display the most helpful reviews in order to promote products, follow this basic flow.\n\n1. Use [Query Reviews](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::2fe27377-f702-4993-a463-fcff15831a52slug::query-reviews*fallback::https://dev.wix.com/docs/rest/api-reference/wix-reviews/reviews/query-reviews) to get a list of the 10 most helpful reviews, sorted by most to least helpful.\n\n2. Display the retrieved reviews in a widget using Wix Blocks. Learn more about [Wix Blocks apps](fallback::https://support.wix.com/en/article/wix-blocks-design-guidelines-for-applications). \n\n"},{"displayName":"Sort and Filter","slugifyName":"sort-and-filter","content":"# Reviews: Supported Filters and Sorting\n\nThe following table shows field support for filters and sorting for review properties:\n\n| Fields | Supported Filters | Sortable |\n| ----------- | ----------- | ----------- |\n| `id` | `$eq`, `$ne`, `$in` | |\n| `namespace` | `$eq`, `$ne`, `$in` | |\n| `entityId` | `$eq`, `$ne`, `$in` | |\n| `content.rating` | `$eq`, `$ne`, `$in`, `$lt`, `$lte`, `$gt`, `$gte` | Sortable |\n| `content.media` | `$isEmpty` | |\n| `helpfulness` | `$eq`, `$ne`, `$in`, `$lt`, `$lte`, `$gt`, `$gte` | Sortable |\n| `moderation.moderationStatus` | `$eq`, `$ne`, `$in` | |\n| `createdDate` | `$eq`, `$ne`, `$in`, `$lt`, `$lte`, `$gt`, `$gte` | Sortable |"}]},"reviewStatus":"APPROVED","isLocked":true,"metadata":{"packageVersion":""}}