Export site setup to a spreadsheet

Overview

Download every location's review site URLs and landing page URLs as a spreadsheet.

Use this to audit a large account or to make edits in bulk. The file is in the format that Import site setup from a spreadsheet accepts.

You'll need the account.

Returns a link to the file (.xlsx). It has one row per review site on each active or pending location, with the columns Location Name, Address, City, State, Zip, SAU Code, Review Site, Url and Landing Page URL. Review sites with ids 9 and 52 are left out.

Prerequisites

• A bearer token. See Authentication.
• The account's id (account_id).

Base URL

Endpoint

POST /api/v1/store-review-site/excel/list

Authentication

Partner or Account token

• account_id must be an account inside your own account tree. A Partner token can export any account under the partner; an Account token only its own account.
• An account outside your tree is rejected with 422.

Rate limit

60 requests per minute, counted per user (the token’s user). See Rate limits.

Request parameters

None.

Request body

Request payload

{
  "account_id": 5994
}

Response body

The payload is inside data.

Response payload

{
  "data": {
    "path": "https://<bucket>.s3.amazonaws.com/download/excel/2026-10/3f2c9b1e-7a4d-4c55-9e0f-1b2a3c4d5e6f-ReviewSiteData.xlsx?X-Amz-Expires=900&X-Amz-Signature=<signature>"
  }
}

Examples

Success payload

See Response payload.

Error payload

422 Missing account_id

{
  "message": "The account id field is required.",
  "errors": {
    "account_id": [
      "The account id field is required."
    ]
  }
}

422 Account doesn't exist or is outside your tree

{
  "message": "The selected account id is invalid. (and 1 more error)",
  "errors": {
    "account_id": [
      "The selected account id is invalid.",
      "The selected account id does not belong to your company hierarchy."
    ]
  }
}

429 Too many requests

{
  "message": "Too Many Attempts."
}

Example request

curl --request POST \
  --url "https://production-api.shoutaboutus.com/api/v1/store-review-site/excel/list" \
  --header 'Authorization: Bearer <bearer-token>' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"account_id": 5994}'