REreacherapp
Shop Health

Orders, returns or chats behind one Shop Performance Score metric

Changed on

The problem items TikTok attributes to one metric on one snapshot day (default: the latest stored snapshot), paged and ordered by TikTok's page then item key. pagination.stored_total is what Reacher holds; upstream_total/upstream_truncated are TikTok's own count and whether it cut the list. snapshot_date is null with an empty page when nothing is stored. Single-shop only.

post/shop-health/problems

Request

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

Request body

metric_code'NRR' | 'NBFR' | 'SFCR' | 'OTDR' | 'AHT' | 'IM_DSAT' required
snapshot_datestring date nullable

Snapshot day; defaults to the latest stored snapshot for this metric.

pageinteger
page_sizeinteger
versioninteger nullable

Collector run to page through, as returned in version by the first page. Pass it back on later pages, together with the snapshot_date the first page resolved, so a rerun between requests cannot duplicate, skip or silently empty the list; omitted = newest run.

Response

Successful Response

shop_idinteger required
metric_code'NRR' | 'NBFR' | 'SFCR' | 'OTDR' | 'AHT' | 'IM_DSAT' required
snapshot_datestring nullable

Resolved snapshot day; null when none is stored.

upstream_totalinteger nullable

TikTok's own count of problem items for this metric.

upstream_truncatedboolean nullable
versioninteger nullable

Collector run the items come from; pass back as version for later pages.

Changes