Load a widget's reviews and settings

Fetch everything the embedded widget needs to render: its style and the reviews to show. Called by the embed code when the page loads. Without feed_data (or with 0) you get the widget's settings only, inside data; with feed_data=1 you get a page of reviews from the widget's locations (newest first, limited to the review site in the widget's options), the average rating and the settings, with data as the review array.

Prerequisites: a bearer token, and the widget's unique_id (from the embed code or List review widgets). The widget's location needs an active widget add-on, otherwise 400.

Authentication: Partner or Account token. Any valid token works; the widget doesn't have to be in your account tree, because it's shown on public pages.

Rate limit: none.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required
Defaults to abc123

Required. The widget's unique id. Must match an existing widget.

integer
enum
Defaults to 0

1 returns the review feed and avg_rating. 0 or left out returns the settings only.

Allowed:
integer
Defaults to 10

Feed page size, 10–100 (values below 10 are raised to 10; above 100 returns 422). When omitted, the widget's numberOfReviews setting, or 3 if that isn't set (either may be below 10).

integer
Defaults to 1

Feed page to return. Default 1.

Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json