Reviews

Analytics KPIs for a single location over a date range.

Changed on

Returns overview review analytics (KPIs) for a location. Two sibling routes return a time-series timeline and a per-site breakdown.

get/api/v4/locations/{locationId}/review-analytics-overview

Request

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

startDatestring date

Start of the analytics period (YYYY-MM-DD). Optional here: it narrows the window the KPIs and their deltas are computed over. Required by the timeline route.

endDatestring date

End of the analytics period (YYYY-MM-DD). Optional here, required by the timeline route.

Response

Successful response

Changes

    • breaking

      added to the response body oneOf list for the response status

    • info

      removed from the response body oneOf list for the response status

    • breaking

      added to the response body oneOf list for the response status

    • breaking

      the response's body type changed from object to no type for status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status