KPI counts, sentiment breakdown, new-vs-closed monthly series, and the recent-activity feed — everything that powers the partner dashboard summary panels.
KPI counts, sentiment breakdown, new-vs-closed monthly series, and the recent-activity feed — everything that powers the partner dashboard summary panels.
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 |
|---|---|---|
GET | Counts (sub-partners / accounts / locations) | Get headline counts of sub-partners, accounts, and locations for the authenticated partner, each with 30-day / 90-day comparison buckets. |
GET | Review-response stats | Get review and response totals for the authenticated partner across last-30-days / previous-30-days / before-30-days windows, plus a KPI summary (response rate %, avg response time, awaiting count). |
GET | Review sentiments (positive / neutral / negative) | Get the review sentiment breakdown (positive / neutral / negative review counts) for the authenticated partner. |
GET | New vs closed location count (last 4 months) | Get new-vs-closed location counts for each of the last four calendar months for the authenticated partner. |
GET | Recent activity log | Get a paginated, newest-first audit/activity feed for the authenticated partner and (if a partner) all of its child account companies. |