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.
Auth: Account — authentication bearer token, inside the generic account-side group; no partner/Hipages/dormant gating. Scope is the caller's own company: stores resolve via and an explicit store_id must sit inside your own account tree. The company block adapts to the caller's bundle: an account (bundle_id == 3) reports its own name with an empty store_name. Otherwise (location-account) it reports the parent company name plus the single store's name. The partner white-label logo comes.
Rate limit: No rate limit.
Request
- Body:
| Field | Type | Required | Notes |
|---|---|---|---|
range_start | string | yes | date_format:Y-m-d H:i:s; start of range. |
range_end | string | yes | date_format:Y-m-d H:i:s; end of range. |
store_id | integer | no | Must be an existing location and pass an ownership check. When omitted, the response covers all of your locations. |
is_pdf | integer | no | in:0,1. When 1, response_feed is capped at 50 rows (and ResponseFeed uses local asset logos instead of S3 URLs). |
Response — { data. } envelope.
start/end(string) — echoed range bounds.company(object) —account_name(string),store_name(string|null),logo(string|null, white-label partner logo).kpis_data(object) — from:total_reviews,avg_rating,total_responded,total_response_rate,avg_response_time,noLoginNoRespons, plus previous-periodtotal_reviews_previous,avg_rating_previous.reviewsSentiments(object) —negativeReviews/_percent,positiveReviews/_percent,neutralReviews/_percent.review_response_by_site(array, re-indexed viaarray_values) — per site:id,review_site,total_reviews,avg_rating,per_of_total,total_response,per_total_response.review_response_by_location(array) — per location:id,name,total_reviews,avg_rating,per_of_total,total_response,per_total_response,avg_response_time.response_feed(array) —ResponseFeedresource collection. Each item carriessource_platform,review,reviewsite,store,store_reviewsite,flag,plan,review_flag,is_flaggable,flag_status,flag_details,response_capabilities, andresponse(null when none).
Errors: 422 on validation failure.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
