Export review-site setup to Excel

Generate an Excel export of all review-site credentials for the stores under the given Account (bundle_id=3 company), stores the file on S3, and returns its public download URL.

Auth: Both — authentication. Target must sit inside your own account tree, keyed on account_id: it must be a non-deleted company row with bundle_id=3, and must place it at or under the auth user's company. A Partner user can therefore export any account in their tree; an Account user can only export their own account. The exported store set (review sites 9 and 52 excluded).

Rate limit: No rate limit.

Request

  • Body:
FieldTypeRequiredNotes
account_idintegeryesAccount company id; must be an existing account, not soft-deleted, and must belong to the auth user's company hierarchy.

Response{ data. } envelope.

  • path (string) — public S3/CloudFront URL of the generated .xlsx file (key pattern download/excel/YYYY-MM/{timestamp}-ReviewSiteData.xlsx). The workbook columns are Location Name, Address, City, State, Zip, SAU Code, Review Site, Url, Username, Password (decrypted), Landing Page URL.

Errors: 422 on validation failure.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
integer
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