Locations table (account)

Overview

Returns a paginated per-location (per-store) response table for the authenticated account — reviews, responses, average response time, average rating, response rate. (Same route/handler as Response report — by location — getResponseReportLocationList.)

Prerequisites

A bearer token. Callable with Account tokens.

Base URL

Environment	URL
Production	`https://production-api.shoutaboutus.com`
Development	`https://development-api.shoutaboutus.com`

Endpoint

POST /api/v1/reports/response/locationlist

Authentication

Requires a bearer token in the Authorization: Bearer <bearer-token> header.
Who can call it: Account tokens.
Mounted under the account-side reports/response group.
Scope: store_id → single store (guarded by an ownership check); else all of the auth user's stores.
No account_id/client_* params on this account variant.

Rate limit

No rate limit.

Request body

Body:

Field	Type	Required	Description
`range_start`	string	yes	`Y-m-d H:i:s`
`range_end`	string	yes	`Y-m-d H:i:s`
`store_id`	integer	no	belongs to auth company
`sort_field`	string	no	`location_name,total_reviews,total_responses,avg_resp_time,avg_rating,response_rate` (default `location_name`)
`sort_by`	string	no	`asc`/`ASC`/`desc`/`DESC` (default `ASC`)
`search_field`	string	no	only `location_name`
`search_value`	string	no
`limit`	integer	no	10–100, values below 10 are raised to 10 (default 10)
`page`	integer	no	min 1

{
  "range_start": "2024-01-01 00:00:00",
  "range_end": "2024-12-31 23:59:59",
  "store_id": 1,
  "sort_field": "total_reviews",
  "sort_by": "desc",
  "limit": 10,
  "page": 1
}

Response

data[].id (int) — store id
data[].location_name (string) — name - storeid
data[].total_reviews / data[].total_responses (int)
data[].avg_resp_time (float, days) / data[].avg_rating (float) / data[].response_rate (float, %)
current_page, last_page, per_page, total

200 OK · `200`

{
  "data": [
    {
      "id": 8748,
      "location_name": "Downtown Location - LOC-001",
      "total_reviews": 13,
      "total_responses": 12,
      "avg_resp_time": 1.2,
      "avg_rating": 4.31,
      "response_rate": 92.11
    }
  ],
  "links": {
    "first": "...?page=1",
    "last": "...?page=2",
    "prev": null,
    "next": "...?page=2"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 2,
    "per_page": 10,
    "to": 10,
    "total": 16
  }
}

Errors

Status	Meaning
`401`	The bearer token is missing, expired or invalid
`422`	The request failed validation — the response names the fields
`500`	Unexpected server error

Example request

curl --request POST \
  --url "https://production-api.shoutaboutus.com/api/v1/reports/response/locationlist" \
  --header 'Authorization: Bearer <bearer-token>' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"range_start": "2024-01-01 00:00:00", "range_end": "2024-12-31 23:59:59", "store_id": 1, "sort_field": "total_reviews", "sort_by": "desc", "limit": 10, "page": 1}'

Updated 8 days ago

Did this page help you?