Promotions

Which seller-funded promotions earn

Changed on

Every seller-funded promotion that touched an order created in the window, one row per promotion and kind, product rows first and then shipping rows, each ranked by line_gmv: orders, units (gift lines excluded), the GMV of the lines that carried it, the mean whole-order GMV of those orders against the same kind's no-promotion baseline, the seller discount it cost and GMV per discount dollar, orders it shared with another promotion of the same kind, and refunded orders. product and shipping promotions are separate rows and must never be summed or ranked together. low_sample marks rows under 20 orders. Numbers cover settled orders only, about a week behind: compare only days before coverage.incomplete_after. A shop the daily price-breakdown sync does not cover reads coverage.state=not_collected with empty rows. Rows total the whole window, so to rank on complete days only, call again with end_date the day before coverage.incomplete_after. Titles, types and windows come from TikTok for the top 20 by line_gmv, cached up to an hour; metadata_status says whether they came back.

get/promotions/performance

Request

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

Query parameters

start_datestring date nullable

Inclusive order-create date (UTC). Defaults to 29 days before end_date.

end_datestring date nullable

Inclusive order-create date (UTC). Defaults to yesterday.

Response

Successful Response

shop_idinteger required
tts_shop_idstring required
start_datestring required

Inclusive order-create date (UTC).

end_datestring required

Inclusive order-create date (UTC).

gift_valuenumber required

Original price of the gift lines given away in the window.

metadata_status'ok' | 'partial' | 'scope_missing' required

ok: every top promotion's title and window came back; partial: some did not; scope_missing: the shop's TikTok grant lacks seller.promotion.info, so rows carry numbers only.

Changes