Creators

Creator activity totals for a window

Four headline totals for the shop over a date window: creators added, affiliate GMV earned, videos posted, and orders placed. Runs the same aggregate query that backs the summary cards above the portal's My Creators table, over the same trailing-28-day default window (TikTok reporting day, GMT-7).

gmv_generated and video_posts are scoped to the shop's CRM-tracked creators, which makes them narrower than their whole-shop namesakes on POST /metrics/summary (gmv, videos_posted) — the two will not agree, by design.

Aggregates cover the whole shop — there is no filter parameter in v1. Defaults to the trailing 28 days. Requires a single shop.

No prior-period comparison is included; for a period-over-period delta, call twice with adjacent windows and subtract. Returns 503 when the aggregate times out — back off and retry rather than treating it as a failure.

post/creators/summary

Request body

start_datestring date nullable

Window start (inclusive). Omit for a trailing 28-day window ending at end_date.

end_datestring date nullable

Window end (inclusive). Defaults to today.

Response

Successful Response

currencystring required

Changes

No recorded changes to this endpoint across all 2 revisions of this API.