Get Dashboard Metrics
GET/api/tiktok-shop/dashboard
Aggregate dashboard metrics for one or many TikTok Shop connections: the connection summaries, synced entity counts (orders, products, returns, refunds, transactions, shops), a financial summary (gross/net revenue, refunds, units sold) for an optional period, and per-entity sync health.
Any valid API token can call this endpoint — no specific scope required. Manage tokens.
Query parameters:
integration_instance_ids(optional, comma-separated integers) — limit to specific connections; omit for all.period(optional, one oftoday,7d,30d) — window for the financial summary; omit for all time. Invalid values return 422.
Authentication: Requires Bearer token.
Request
Responses
- 200
- 401
- 403
- 422
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Unprocessable Entity
Response Headers
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.