Sample request stat cards

The four stat cards above the sample-request table: pendingReview (how many requests await a decision, plus how many of those are expiring soon), approvedInAutoProcess (samples auto-approved by an automation), completionRate (share of approved samples that produced content), and approvalTarget (usage against the shop's approval quota). The change metrics compare against the immediately preceding period of equal length.

dataFreshness reports how current the underlying sample data is — TikTok's sample feed lags, so surface it rather than presenting the counts as real-time.

date_from/date_to must be given together and bound request creation date. Single-shop only.

get/samples/metrics

Query parameters

product_idsstring nullable

Comma-separated product IDs to filter by. Omit for all products.

date_fromstring date nullable

Start of the window (inclusive). Requires date_to.

date_tostring date nullable

End of the window (inclusive). Requires date_from.

exclude_rejectedboolean

Exclude creators previously rejected/cancelled by this shop.

include_archivedboolean

Include sample requests archived in the portal.

Response

Successful Response

Changes

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