get
https://production-api.shoutaboutus.com/api/v1/widget
Get an embeddable review widget by its unique_id, and — when feed_data=1 — the paginated review feed the widget renders. Resolves the widget, verifies the owning store/account has an active widget add-on, then either returns the widget config alone or a ResponseFeed collection of reviews with the average rating. The review-site filter and review count come from the widget's saved options.
Auth
- Bearer — account (account) role. Registered under the account group: a valid account token is required even though the widget renders on public pages. 400 if the add-on is inactive or the widget is missing.
Rate limit
- No rate limit.
Query
| Field | Type | Required | Notes |
|---|---|---|---|
unique_id | string | Required | Must be an existing widget. |
feed_data | integer | Optional | 0 or 1. 1 returns the paginated review feed + avg_rating. |
limit | integer | Optional | Feed page size, 10–100 (values below 10 are raised to 10); when omitted, defaults to the widget's numberOfReviews, else 3. |
Behaviour
-
- Config only (
feed_dataomitted/0):{ "data": { "widget": {. }, "status": "success", "data": null } }.
- Config only (
-
- Feed (
feed_data=1): a paginatedResponseFeedcollection — top-leveldatais the review array, withwidget,status,avg_rating, pluslinks/metafrom pagination.
- Feed (
- 400 widget not found / no active add-on.
Errors: 422 on validation failure.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…