post
https://production-api.shoutaboutus.com/api/v1/partner/pdf/download/performance-report
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.
Auth: Partner — authentication; under partner/pdf group. Handler hard-gates on company.bundle_id == 1 (returns 500 with Access denied. Partner plan required. otherwise). Store set precedence: account_id (account); else store_id → single store; else all partner-user stores. All id params guarded by an ownership check.
Rate limit: No rate limit.
Request
- Body:
| Field | Type | Required | Notes |
|---|---|---|---|
| range_start | string | yes | Y-m-d H:i:s |
| range_end | string | yes | Y-m-d H:i:s |
| store_id | integer | no | belongs to auth company |
| account_id | integer | no | account (bundle_id=3) under this partner |
| client_location_id | string | no | resolved to store_id |
| client_account_id | string | no | resolved to account_id |
Response — { data. } envelope.
start(string) /end(string) — echoed date rangecompany(object) —partner_name,account_name(comma-joined accounts, truncated to 3 + ". And N More Brand(s)"),store_name(same truncation for locations),logo(string|null, from white-label)kpis_data(object) — outputreviewsSentiments(object)review_response_by_site(array) — see by-site shapereview_response_by_location(array) — per-store rows (id,name,total_reviews,avg_rating,per_of_total,total_response,per_total_response,avg_response_time)response_feed(array) —ResponseFeedresource collection (PDF mode)
Errors: 422 on validation failure.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
