LIlistingsapi
Reviews

Newer per-phrase stats breakdown for one or more locations.

Changed on

Returns the phrases customers use most in a location's reviews, each with its own review stats.

get/api/v4/review-phrases

Request

Query parameters

locationIdsstring

JSON-encoded filter object

JSON array of location IDs to aggregate over, e.g. [1800289,1800290]. Query values are JSON-parsed, so a bare single ID also works. Omit to cover every location the key can read.

siteUrlsstring

JSON-encoded filter object

JSON array of review sources to include, e.g. ["maps.google.com"].

startDatestring

Only count reviews on or after this date (YYYY-MM-DD).

endDatestring

Only count reviews on or before this date (YYYY-MM-DD).

searchStringstring

Only return phrases containing this substring.

categorystring

Deprecated single-value form of categories. Kept for v4 compatibility; prefer categories.

ratingFilterinteger

Deprecated single-value form of ratingFilters. Kept for v4 compatibility; prefer ratingFilters.

phraseCountinteger

Maximum number of phrases to return.

categoriesstring

JSON-encoded filter object

JSON array of interaction categories to include (see the interaction attributes reference).

ratingFiltersstring

JSON-encoded filter object

JSON array of star ratings to include, e.g. [1,2] to mine only unhappy reviews.

responseStatusstring

JSON-encoded filter object

JSON array of RESPONDED / PENDING to restrict by whether the review has an owner reply.

sortOrderstring

JSON-encoded filter object

One of NEWEST_FIRST, OLDEST_FIRST, LAST_RESPONDED, LOWEST_RATING, HIGHEST_RATING.

Response

Successful response

Changes