Reviews

Paginated list of interactions across many locations (rollup scope).

Returns a cursor-paginated list of interactions across many locations in the account, with filtering and sorting.

get/api/v4/rollup_interactions

Query parameters

tagstring

Location tag defining the rollup scope. Required — the request returns 400 without it. Use all to span every location.

locationFiltersstring

JSON-encoded filter object

JSON-encoded array of location IDs to restrict the rollup to.

siteUrlsstring

JSON-encoded filter object

JSON-encoded array of publisher hostnames to include.

startDatestring

Start of the date-range filter (YYYY-MM-DD).

endDatestring

End of the date-range filter (YYYY-MM-DD).

searchStringstring

Full-text search across interaction content.

categorystring

Single interaction category, e.g. REVIEW.

categoriesstring

JSON-encoded filter object

JSON-encoded array of interaction categories.

ratingFiltersstring

JSON-encoded filter object

JSON-encoded array of star ratings to include, e.g. [3,4].

ratingFilterinteger

Single star rating to filter by.

responseStatusstring

JSON-encoded filter object

JSON-encoded response-status filter. Values: RESPONDED, PENDING.

sortOrderstring

JSON-encoded filter object

JSON-encoded sort order. Values: NEWEST_FIRST, OLDEST_FIRST, LAST_RESPONDED.

firstinteger

Number of records to return from the beginning.

afterstring

Cursor value — return records after this cursor (forward pagination).

lastinteger

Number of records to return from the end.

beforestring

Cursor value — return records before this cursor (backward pagination).

Response

Successful response

totalCountinteger

Changes