Review and response performance across every account and location you manage.
Review and response performance across every account and location you manage.
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, average ratings, response rate, average response time, awaiting-response backlog, sentiment split) for the partner's review-response report. |
POST | Performance by location | Returns a paginated, per-location (per-store) review-response table for the partner — reviews, responses, average response time, average rating, and response rate per store. |
POST | Performance by review site | Returns review/response metrics grouped by review site (publisher) for the partner — per-site review count, average rating, % of total, response count, and response rate. |
POST | Export to Excel | Generate the partner review-response feed as an Excel file, stores it on S3, and returns the public download URL. |
POST | Export performance report to PDF | Returns the full data payload used to render the partner performance report PDF — header company info, KPI block, sentiment split, by-site, by-location, and the response feed. |
POST | Lifetime reviews by site | Returns per-publisher lifetime totals (all-time review count + overall rating from the synced per-store review-site connections, including partner-specific sites) plus the selected-period review count and rating, scoped to the partner. |