Review widget
Endpoints that power the embeddable review widget: fetch a widget's config/feed by unique_id, record view/click activity, and list available widget types.
Endpoints that power the embeddable review widget: fetch a widget's config/feed by unique_id, record view/click activity, and list available widget types. Registered under the account group — a valid account bearer token is required even though the widget renders on public pages. Account-side widget config CRUD (list/create-or-update/delete) lives in § Account — FAQ, images & widgets.
Prerequisites
- A bearer token in the
Authorizationheader. Any endpoint that needs no token says so on its own page. - The id of each record the call targets. Every endpoint page lists the ids it needs.
Required parameters
Each endpoint requires specific parameters to function. Refer to the individual endpoint pages for the complete list of required parameters for that endpoint.
Errors
| Status | Meaning |
|---|---|
401 | The bearer token is missing, expired or invalid |
403 | The token is valid but the record sits outside your account |
422 | The request failed validation — the response names the fields |
500 | Unexpected server error |
Individual endpoints may return more; each page lists its own.
Endpoints
GET — Get an embeddable review widget by its unique_id, and — when feed_data=1 — the paginated review feed the widget renders.
POST — Record a view or click event for a widget, deduplicated per widget + activity type + IP + device per calendar day (increments a running total_count when the same combination is seen again that day).
GET — List all active widget types for the widget builder, plus the widget add-on status when you supply store_id (whether the store has an active add-on and which store ids it covers).
Updated 14 days ago