Response performance for one business: totals, by location, by site, rankings, and exports.
Response performance for one business: totals, by location, by site, rankings, and exports.
Prerequisites
- A bearer token in the
Authorizationheader. Any endpoint that needs no token says so on its own page. - The id of each record the call targets. Every endpoint page lists the ids it needs.
Errors
| Status | Meaning |
|---|---|
401 | The bearer token is missing, expired or invalid |
403 | The token is valid but the record sits outside your account |
422 | The request failed validation — the response names the fields |
500 | Unexpected server error |
Individual endpoints may return more; each page lists its own.
Endpoints
| Method | Endpoint | Description |
|---|---|---|
POST | Headline numbers | Returns period-over-period KPI cards (review counts, ratings, response rate, average response time, awaiting-response, sentiment split) for the account-scoped response report. |
POST | Performance by location | Returns a paginated per-location (per-store) response table for the authenticated account — reviews, responses, average response time, average rating, response rate. |
POST | Performance by review site | Returns review/response metrics grouped by review site (publisher) for the authenticated account — per-site review count, average rating, % of total, response count, response rate. |
POST | Lifetime reviews by site | Returns per-publisher lifetime totals (all-time count + overall rating from the synced pivot, partner-specific sites via bridge) plus the selected-period review count and rating, scoped to the authenticated account. |
GET | Star rating breakdown | Get total review count plus a per-star breakdown for a single store, plus a canonical average rating and an off-platform review count. |
POST | Ranking report | Ranks the authenticated account's locations against each other over a date range — by review volume, average rating, and response rate — and computes a blended overall rank with a letter grade. |
POST | Export to Excel | Generate a review-response feed Excel workbook for the caller's stores over a date range, stores it on the S3 disk, and returns the public download URL. |
POST | Export performance report to PDF | Returns the full performance-report dataset for a PDF: header/company block, KPIs (with previous-period comparisons), sentiment split, per-site and per-location review/response breakdowns, and the review-response feed. |