v3

latestOpenAPI 3.1.0Proprietary (Listings API Terms of Service)2026-07-3156148214.6 KB
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, counting forward from the start of the result set.

afterstring

Cursor to page forward from. Pass pageInfo.endCursor, or equivalently the cursor of the last edge in the previous page. Stop paging when pageInfo.hasNextPage is false, or when a page returns an empty edges array.

lastinteger

Number of records to return, counting backward from the end of the result set.

beforestring

Cursor to page backward from, used with last. Pass the cursor of the first edge of the page you are moving back from — the gateway's shared PageInfo type exposes no startCursor field.

Response

Successful response

totalCountinteger