Performance by location

post

https://production-api.shoutaboutus.com/api/v1/reports/response/locationlist

Get a row per location in the account, for the locations with reviews in the period, 10 per page unless you set limit. Use this to compare locations.

Prerequisites: a bearer token and a date range (range_start, range_end, both Y-m-d H:i:s). Optional: a location id (store_id).

Authentication: Partner or Account token. Without store_id the report covers every location the token can see; store_id must be inside your own account 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 period, Y-m-d H:i:s (e.g. 2026-01-01 00:00:00). A date without a time is rejected.

range_end

string

required

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

End of the period, Y-m-d H:i:s (e.g. 2026-09-30 23:59:59).

store_id

integer

Defaults to 3007

One location to report on. Must exist and be inside your account tree. Leave it out to cover every location your token can see.

sort_field

string

enum

Defaults to total_reviews

Column to sort by: location_name, total_reviews, total_responses, avg_resp_time, avg_rating, response_rate. Default location_name.

Allowed:

sort_by

string

enum

Defaults to desc

Sort direction: asc or desc (either case). Default ASC.

Allowed:

search_field

string

enum

Defaults to location_name

Field to search. Only location_name. Used together with search_value.

Allowed:

search_value

string

Defaults to Sydney

Text to search for. Matches locations whose name, store code or client_location_id contains it. Applies only when search_field is also sent.

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, from 1. 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 page of location rows.

401The token is missing, expired or invalid.

422A date is missing or not Y-m-d H:i:s, store_id doesn't exist or is outside your tree, a sort or search value isn't allowed, or limit is above 100.

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

500Unexpected server error.