Get Etsy Dashboard
GET/api/etsy/instances/:integrationInstance/dashboard
Returns an overview of one Etsy instance: connection state, record counts, revenue summary, per-entity sync health, the automatic sync schedule (orders every 15 minutes, listings daily, inventory every minute, tracking on fulfillment), the latest order and listing, and order/listing/inventory KPIs.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Revenue (financial_summary) covers paid orders only and excludes the sales tax Etsy collects and remits; net_revenue = gross − refunds.
Query parameters:
period(string, optional) — Revenue window:today,7d, or30d. Omit for all time.
Response highlights:
sync_summary.overall_health.status—excellent,fair, orcritical.sync_summary.auto_sync.schedules.*.seconds_until_next—nullwhen that schedule is inactive;inactive_reasonexplains why.kpis.orders—total,linked(has a SKU.io sales order),pending(paid/completed without one),canceled,unshipped_paid,address_withheld,tracking_failed(archived orders excluded).kpis.listings— listing/variation totals, mapping counts, push errors, shared-quantity listings, expired listings.
kpis.tracking — tracking passback freshness: last_submitted_at (when Etsy last accepted tracking for this shop) and submitted_last_24h.
Authentication: Bearer token (Personal Access Token).
Request
Responses
- 200
- 401
- 403
- 404
- 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.
Not Found
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.