Sign in
Metrics

Dashboard headline metrics

Pre-computed headline scalar metrics for a date range, matching the Reacher dashboard's top-level KPIs exactly. Use this for summary cards and headline numbers. Includes derived metrics like active_creators (distinct count, not daily sum), gmv_per_video, and gmv_per_sample, plus sc_affiliate_live_gmv (creator LIVE GMV as Seller Center reports it — order-date attributed, so it does not match live_gmv). Also includes Seller Center whole-shop cards: orders, units_sold, aov, ctr, conversion_rate (all-channel; aov/ctr/conversion_rate are ratios computed over the full window). Defaults to the last 30 days if no dates are specified. Dates default to the newest day with settled data for the shop (typically yesterday; up to 2 days back while a day finalizes).

post/metrics/summary

Request body

start_datestring date nullable
end_datestring date nullable

Response

Successful Response

gmvnumber nullable

Affiliate-attributed GMV for the period — Reacher's view of creator-driven sales. This is NOT the shop's full GMV. For the headline number that matches the customer's TikTok Seller Center dashboard (which includes ads / Smart+ and organic), use total_gmv or the dedicated POST /shop-gmv/* endpoints.

total_gmvnumber nullable

Full shop GMV for the period — includes ads / Smart+ and organic revenue, not just affiliate-attributed sales. Sourced from the TikTok Seller Center scrape. Coverage is rolling out per-shop; shops not yet covered return 0. For per-day breakdown by channel (video / live / product_card) and explicit per-shop currency handling, use POST /shop-gmv/* instead.

live_gmvnumber nullable

Creator LIVE-attributed GMV for the period — the value shops see on TikTok's Affiliate Center → LIVE streams (/insights/transaction-analysis). Sourced from customers.live_sessions (affiliate_gmv), a DIFFERENT source than gmv (all affiliate revenue) and total_gmv (full shop view). Isolates the LIVE-stream slice only. Coverage is data-presence driven; shops without live-session data return 0. Currency is per-shop — for the currency-aware, single-shop, per-session view use the dedicated POST /lives/* endpoints.

sc_affiliate_live_gmvnumber nullable

Creator LIVE GMV for the period exactly as TikTok Seller Center reports it — Analytics → By order source → Creator → Lives. Use this one to reconcile against a Seller Center export. It is NOT the same figure as live_gmv, which comes from Affiliate Center and attributes revenue on transaction date rather than order date; the two will not match. Sourced from the same Seller Center daily rollup as total_gmv, so the same caveats apply: coverage is rolling out per-shop and uncovered shops return 0, and currency is per-shop (multi-shop requests sum across currencies). For the per-day channel breakdown use POST /shop-gmv/*.

active_creatorsnumber nullable

Distinct creators with activity in the period (not summed daily counts)

video_viewsnumber nullable

Total video views in the period

videos_postednumber nullable

New videos posted in the period

samples_approvednumber nullable

Samples approved in the period

gmv_per_videonumber nullable

Avg GMV per video posted in the period. Matches dashboard 'GMV per Video'

gmv_per_samplenumber nullable

Avg GMV per sample. Matches dashboard 'GMV per Sample'

sample_requestsnumber nullable

Total sample requests in the period

gmv_driving_videosnumber nullable

Videos that generated sales in the period

new_creators_postingnumber nullable

First-time creators who posted in the period

open_collabsnumber nullable

Open collaboration affiliates added

accepted_tc_countnumber nullable

Accepted target collaborations

creators_reachednumber nullable

Creators reached via outreach

creators_messagednumber nullable

Creators messaged

tc_invites_sentnumber nullable

Target collaboration invites sent

emails_sentnumber nullable

Emails sent

dm_responsesnumber nullable

Sum of daily unique DM responses (not deduplicated across the period)

reply_ratenumber nullable

DM reply rate: (dm_responses / dm_messages_sent) * 100

ordersnumber nullable

Whole-shop orders for the period across all sales channels, from TikTok Seller Center. Shops not yet on the Seller Center daily sync return 0.

units_soldnumber nullable

Whole-shop units sold for the period across all sales channels, from TikTok Seller Center. 0 for shops not yet covered.

aovnumber nullable

Average order value for the period (total GMV / total orders over the date range, not an average of daily AOV). 0 when the shop has no orders or is not yet covered.

ctrnumber nullable

Click-through rate as a percent for the period (total clicks / total impressions over the date range). 0 when uncovered or no impressions.

conversion_ratenumber nullable

Conversion rate as a percent for the period (total orders / total clicks over the date range). 0 when uncovered or no clicks.

errorsstring[] nullable

Metric keys that failed (null values in response)

start_datestring required
end_datestring required
currencystring required
shops_queriedstring[] nullable

Shop names included when querying multiple shops (x-shop-id: all or comma-separated).

Changes

No recorded changes to this endpoint across all 1 revision of this API.