API Reference

Export to Excel

post
https://production-api.shoutaboutus.com/api/v1/partner/excel/download/review-response-feed

Download the review and response feed for the period as a spreadsheet. Use this for offline analysis or sharing. Returns a link to the .xlsx file.

Prerequisites: a Partner bearer token and a date range (range_start, range_end, both Y-m-d H:i:s). Optional: an account_id or store_id to narrow the export.

Authentication: Partner token; any other token gets 500 (Access denied. Partner plan required.). It covers every location under your partner, or one account or location when you send account_id or store_id; every id must be inside your tree, otherwise 422.

Rate limit: 60 requests per minute, counted per user (the token’s user).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
Defaults to 2026-01-01 00:00:00

Start of the date range, as Y-m-d H:i:s.

string
required
Defaults to 2026-09-30 23:59:59

End of the date range, as Y-m-d H:i:s.

integer
Defaults to 3007

One location to report on. Must exist and be inside your tree.

integer
Defaults to 5994

One account under your partner (an account id, not a location). Must exist and be inside your tree.

string
length ≤ 255
Defaults to LOC-001

Your own id for a location. Used in place of store_id when store_id isn't sent. Max 255 characters; must be inside your tree.

string
length ≤ 255
Defaults to ACC-001

Your own id for an account. Used in place of account_id when account_id isn't sent. Max 255 characters; must be inside your tree.

string
length ≤ 255

Reserved. Accepted (max 255 characters) but not used.

Responses

Updated 18 days ago

Did this page help you?
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

Updated 18 days ago

Did this page help you?