Performance

Account-scope dashboard tabs — KPI cards, locations table, reviews-by-site, exports.

Account-scope dashboard tabs — KPI cards, locations table, reviews-by-site, exports. Excludes partner-aggregate views (those live in Performance Report (partner)).

Prerequisites

A bearer token in the Authorization header. 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`	KPI cards (account)	Returns period-over-period KPI cards (review counts, ratings, response rate, average response time, awaiting-response, sentiment split) for the account response report.
`POST`	Locations table (account)	Returns a paginated per-location (per-store) response table for the authenticated account — reviews, responses, average response time, average rating, response rate.
`POST`	Reviews-by-Site (account)	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`	Excel export (account)	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`	PDF export (account)	Returns the full performance-report dataset for a PDF: company block, KPIs (with previous-period comparisons), sentiment split, per-site and per-location review/response breakdowns, and the review-response feed.
`POST`	Annual volume + rating chart (account-only)	Returns the last 12 months (relative to `date`) of per-month review volume, average rating, cumulative overall rating, and response counts for an account or a single store — used to drive the annual volume + rating chart.
`GET`	Review-site dropdown	GET variant of the same route backing the review-site dropdown — returns the selectable review-site catalog (value/label pairs) for an account: the union of review sites on the plans assigned to the account's account(s), with hipages pinned first, then Google (44) and Yelp (1).