Excel — review-response feed

Overview

Generate a review-response feed Excel workbook for the caller's stores over a date range. It stores the workbook on the S3 disk and returns the public download URL.

Prerequisites

• A bearer token. Callable with Account tokens.

Base URL

Endpoint

POST /api/v1/reports/excel/review-response-feed

Authentication

• Requires a bearer token in the Authorization: Bearer <bearer-token> header.

• Who can call it: Account tokens.

• Inside the generic account-side group; no partner/Hipages/dormant gating.

• Scope is the caller's own company: stores resolve from user-assigned stores, assigned-account stores, or the full account tree beneath it. An explicit store_id must sit inside your own account tree, so it must sit in the caller's company hierarchy.

• The header row shows the caller's account name.

Rate limit

• No rate limit.

Request body

• Body:

{
  "range_start": "2024-01-01 00:00:00",
  "range_end": "2024-12-31 23:59:59",
  "store_id": 1,
  "search": ""
}

Response

• data.path (string) — S3 URL to the generated .xlsx, stored at download/excel/{Y-m}/{timestamp}-ReviewResponseReport.xlsx.

200 Success · 200

{
  "data": {
    "path": "https://s3.amazonaws.com/bucket/download/excel/2024-01/1719300000-ReviewResponseReport.xlsx"
  }
}

Errors

Example request

curl --request POST \
  --url "https://production-api.shoutaboutus.com/api/v1/reports/excel/review-response-feed" \
  --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, "search": ""}'