Reviews

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.

get/api/v4/locations/{locationId}/reviews

Path parameters

integer required

Raw numeric ID

OR
string base64-or-int required

Base64-encoded Relay ID

Location ID, a raw numeric database ID (e.g. 1800289) or its Base64-encoded Relay ID (e.g. TG9jYXRpb246MTgwMDI4OQ==).

Query parameters

siteUrlsstring

JSON-encoded filter object

JSON-encoded array of publisher hostnames to include, e.g. ["maps.google.com","yelp.com"].

startDatestring

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

searchStringstring

Full-text search across interaction content.

endDatestring

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

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

Changes

Changed in 2 of the 4 revisions of this API.21

    • deleted the query request parameter tag

      request-parameter-removed

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 9274a1eac38011See the full diff
    • removed the optional property pageInfo/startCursor from the response with the 200 status

      response-optional-property-removed

    • added the optional property pageInfo/total to the response with the 200 status

      response-optional-property-added

    This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog