Listings API

Parameters

Path

Name	Type	Required	Description
locationId	string	required	Location ID — a raw numeric database ID (e.g. `1800289`) or its Base64-encoded Relay ID (e.g. `TG9jYXRpb246MTgwMDI4OQ==`).

Query

Name	Type	Required	Description	Default
startDate	string	optional	Start of the analytics period (YYYY-MM-DD). Required for the `review-analytics-timeline` route.	—
endDate	string	optional	End of the analytics period (YYYY-MM-DD). Required for the `review-analytics-timeline` route.	—

Responses

200Overview analytics for the location.

{
  "data": {
    "interactionsAnalyticsStats": {
      "stats": [
        { "name": "total-reviews", "value": 9705423, "delta": 100 },
        { "name": "new-reviews", "value": 9705423, "delta": 100 },
        { "name": "overall-rating", "value": 4.432533457738633, "delta": 100 },
        { "name": "review-response-rate", "value": 47.39994331004429, "delta": 100 }
      ]
    }
  }
}

401Unauthenticated — missing or invalid API key.

Returns review analytics for a single location. This route returns the overview KPIs; swap the final path segment to select a different analytics shape:

review-analytics-overview — overall stats: total-reviews, new-reviews, overall-rating (average, 1–5), and review-response-rate (percentage). Response key: interactionsAnalyticsStats.
review-analytics-timeline — daily time-series of interaction count and average rating for a date range. Response key: interactionsChartData. Requires startDate and endDate.
review-analytics-sites-stats — per-platform breakdown showing average rating, total interactions, and recent activity for each source site. Response key: interactionsSitesStats.

Each entry in stats carries a name, a value, and a delta. The delta is the percentage change relative to the previous equivalent period (a fresh account with no prior period reports 100).

Use case: a location scorecard tile

To render a "reviews at a glance" tile for a store dashboard, call this endpoint with just the location ID — no date range is needed for the overview. Read overall-rating for the headline star average and review-response-rate to show how many reviews the team has replied to. Pair it with review-analytics-timeline (passing startDate/endDate) when the tile needs a 30-day trend sparkline.

The locationId accepts either the raw numeric database ID or the Base64 Relay ID interchangeably, so you can reuse the same ID you got back from List all locations.