REreacherapp
Shop Health

Shop Performance Score metrics (per-metric status, value, thresholds)

Changed on

Every stored snapshot of TikTok's six Shop Performance Score metrics for one shop in the window (NRR, NBFR, SFCR, OTDR, AHT, IM_DSAT): status (EXCELLENT/GOOD/POOR/CRITICAL/NIL), value with unit, thresholds, evaluation window, and how many problem items TikTok reported. latest_snapshot_date names the newest day; a metric absent on that day has no data. Window: a preset or explicit dates, max 365 days. Single-shop only.

post/shop-health/metrics

Request

  • Base URL
    https://api.reacherapp.com/public/v1
  • URL
    https://api.reacherapp.com/public/v1/shop-health/metrics
  • Auth
    API key in header x-api-key and API key in header x-shop-id

Request body

presetstring nullable

Relative window ending at the shop's newest settled day: <n>d (1-999), <n>m (1-99) or all, always capped at 365 days. Mutually exclusive with explicit dates; defaults to 30d when neither is given.

start_datestring date nullable

Inclusive window start (YYYY-MM-DD).

end_datestring date nullable

Inclusive window end (YYYY-MM-DD).

metric_codesstring[] nullable

Restrict to these metric codes; all six when omitted.

Response

Successful Response

shop_idinteger required
start_datestring required
end_datestring required
latest_snapshot_datestring nullable
snapshot_countinteger required

Distinct snapshot days in the window.

Changes