Skip to main content
GET
Get all reviews for pages

Authorizations

Authorization
string
header
required

HTTP Basic Authentication using API Key and Secret Key. The credentials should be Base64 encoded in the format 'api_key:secret_key'. You can obtain your API Key and Secret Key from Feedspace → Automation → API (https://app.feedspace.io/automation/api).

Query Parameters

page
integer

Page number (default: 1)

sort_order
enum<string>

Sort order for reviews. Use 'asc' for ascending or 'desc' for descending. Only applied when only_selected_feed=1. For every other request the results are always returned latest first and this parameter is ignored.

Available options:
asc,
desc
filter[feed-types][]
enum<string>[]

Filter by review types. Can specify multiple values. Accepted values: 'text', 'video', 'audio', 'social'. Reviews are matched by the media they carry, not by their stored feed_type, so a returned item's type can differ from the value you filtered on. For example, a social review that has a video attachment (such as an imported Instagram or YouTube video) is returned by video even though it is a social_feed. In full: video and audio return native video/audio reviews plus any social review that carries a video or audio attachment; text returns native text reviews plus text reviews you added manually (stored as social_feed). Platform and web link reviews that only contain text are returned by social, not text.

Available options:
text,
video,
audio,
social
filter[favourite]
enum<string>

Filter for favourite reviews. Use '1' for favourite, '0' or omit for all

Available options:
0,
1
filter[feed-forms][]
integer[]

Filter by review form IDs. Can specify multiple form IDs. Use the numeric id of the form, not its unique_form_id.

filter[review_with_comment]
enum<string>

Filter for reviews with comments. Use '1' to show only reviews with comments

Available options:
0,
1
filter[sentiments][]
enum<string>[]

Filter by sentiment IDs. Can specify multiple sentiment IDs

Available options:
positive,
neutral,
negative
filter[star-rating][]
enum<integer>[]

Filter by star rating. Send one or more values from 1 to 5; the filter matches the inclusive range between the lowest and highest values you send.

Available options:
1,
2,
3,
4,
5
filter[review-labels][]
string[]

Filter by review label IDs. Can specify multiple label IDs

Search filter for reviews. Searches across review content

only_selected_feed
enum<string>

Return only selected reviews. Use '1' to return only selected reviews

Available options:
0,
1
per_page_limit
integer

Number of items per page. Defaults to 1000 when omitted.

Required range: 1 <= x <= 1000

Response

200 - application/json

Page reviews fetched successfully.

data
object
unique_form_id
string