Paginated list of interactions (reviews / Q&A / social) for a single location, with filters.
Returns a cursor-paginated list of reviews and social interactions for a single location, with filters.
Path parameters
Location ID, a raw numeric database ID (e.g. 1800289) or its Base64-encoded Relay ID (e.g. TG9jYXRpb246MTgwMDI4OQ==).
Query parameters
JSON-encoded filter object
JSON-encoded array of publisher hostnames to include, e.g. ["maps.google.com","yelp.com"].
Start of the date-range filter (YYYY-MM-DD).
Full-text search across interaction content.
End of the date-range filter (YYYY-MM-DD).
Single interaction category, e.g. REVIEW.
JSON-encoded filter object
JSON-encoded array of interaction categories.
JSON-encoded filter object
JSON-encoded array of star ratings to include, e.g. [3,4].
Single star rating to filter by.
JSON-encoded filter object
JSON-encoded response-status filter. Values: RESPONDED, PENDING.
JSON-encoded filter object
JSON-encoded sort order. Values: NEWEST_FIRST, OLDEST_FIRST, LAST_RESPONDED.
Number of records to return, counting forward from the start of the result set.
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.
Number of records to return, counting backward from the end of the result set.
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
Changes
Changed in 2 of the 4 revisions of this API.21
- ●
deleted the
queryrequest parametertagrequest-parameter-removed
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ●
- ●
removed the optional property
pageInfo/startCursorfrom the response with the200statusresponse-optional-property-removed
- ○
added the optional property
pageInfo/totalto the response with the200statusresponse-optional-property-added
This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ●