Skip to main content
Documentation

Domain

Reviews capabilities

11 capabilities, all acting on a review. A reference to one from another domain is spelled review_id — never a bare id — and every one of those fields names the capability that produces it, so a model can chain calls without guessing.
CapabilityWhat it doesEffect
reviews.listPOST /api/v1/reviews/listList the shop's public reviews and which are still unansweredread-only
reviews.getPOST /api/v1/reviews/getGet one public review, its text and the shop's replyread-only
reviews.insightsPOST /api/v1/reviews/insightsRead the shop's review score, response rate and overdue repliesread-only
reviews.ask_funnelPOST /api/v1/reviews/ask_funnelMeasure how many review asks turned into actual reviewsread-only
reviews.unreviewed_asksPOST /api/v1/reviews/unreviewed_asksList customers asked for a review who never left oneread-only
reviews.private_feedbackPOST /api/v1/reviews/private_feedbackRead the private ratings customers gave without posting a reviewread-only
reviews.postsPOST /api/v1/reviews/postsList the posts the shop published beside its reviews on Googleread-only
reviews.replyPOST /api/v1/reviews/replyPublish the shop's reply to one public reviewwrites
reviews.requestPOST /api/v1/reviews/requestText one customer asking them to leave the shop a reviewwrites · reaches the customer
reviews.for_customerPOST /api/v1/reviews/for_customerFind what one customer has said in ratings and public reviewsread-only
reviews.settingsPOST /api/v1/reviews/settingsRead how this shop asks for reviews and routes the unhappy onesread-only

← Every domain