Excel — review-response feed

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.

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 (user-assigned stores, assigned-account stores, or the full account tree beneath it), and an explicit store_id must sit inside your own account tree so it must sit in the caller's company hierarchy. The header row shows the caller's account name.

Rate limit: No rate limit.

Request

  • Body:
FieldTypeRequiredNotes
range_startstringyesdate_format:Y-m-d H:i:s; start of range.
range_endstringyesdate_format:Y-m-d H:i:s; end of range.
store_idintegernoMust be an existing location and pass an ownership check. When omitted, the response covers all of your locations.
searchstringnomax:255. Accepted by the request validation but not consumed by the controller method.

Response{ data. } envelope.

  • path (string) — S3 URL to the generated .xlsx, stored at download/excel/{Y-m}/{timestamp}-ReviewResponseReport.xlsx.

Errors: 422 on validation failure.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
string
integer
string
Response

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json