Performance by location

post

https://production-api.shoutaboutus.com/api/v1/partner/report/review-response/by-location

Get a row per location with its reviews, responses, rating, and response rate for the period. Use this for a leaderboard or to find locations that need attention. Sortable and searchable; returns one row per location, a page at a time.

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

Authentication: Partner token. 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: 120 requests per minute, counted per user (the token’s user).

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

range_start

string

required

Defaults to 2026-01-01 00:00:00

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

range_end

string

required

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

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

store_id

integer

Defaults to 3007

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

account_id

integer

Defaults to 5994

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

client_location_id

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.

client_account_id

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.

sort_field

string

enum

Defaults to total_reviews

Column to sort by. Default location_name.

Allowed:

sort_by

string

enum

Defaults to desc

Sort direction. Default ASC.

Allowed:

search_field

string

enum

Defaults to location_name

Field to search. Only location_name.

Allowed:

search_value

string

Defaults to Sydney

Text to look for in the location's name, storeid or client_location_id. Used only with search_field.

limit

integer

Defaults to 10

Rows per page, 10 to 100. Values below 10 are raised to 10; above 100 returns 422. Default 10.

page

integer

Defaults to 1

Page number. Default 1.

Responses

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200One row per location, a page at a time.

401The token is missing, expired or invalid.

422A date is missing or not Y-m-d H:i:s, an id doesn't exist or is outside your tree, sort_field / sort_by / search_field isn't an allowed value, or limit is above 100.

429More than 120 requests in a minute from this user.

500Unexpected server error.