Skip to main content

Get Shopify Dashboard

GET 
/api/shopify/dashboard

Aggregate dashboard metrics across every Shopify connection the user can see: connection summaries, synced entity counts, a financial summary for an optional period, per-entity sync health with the next scheduled run, and the initial order backfill state for each connection.

Authorization

Any valid API token can call this endpoint — no specific scope required. Manage tokens.

Query parameters:

  • integration_instance_ids (optional, comma-separated integers) — limit the aggregation to specific connections; omit for every connection the user can access.
  • period (optional, one of today, 7d, 30d, 90d) — window for the financial summary; omit for all time. Any other value returns 422.

order_backfills[] — one entry per connection describing the first full order import:

  • status — never (not started), running, completed, or failed.
  • window_start (ISO 8601) — how far back the import reaches. Resolved from the connection's start date, then the tenant inventory start date, then a bounded 90-day fallback; it is never open-ended.
  • window_source / window_source_label — which of those produced window_start.
  • window_is_explicit — true when the merchant configured the date, false when it was inferred.
  • started_at / completed_at / failed_at / error — timestamps and the last failure message.
  • orders_imported — orders the import itself counted (null until it completes).
  • remote_order_count — Shopify's own count of orders in the same window, taken when the import finished.
  • local_order_count — orders stored locally for that window, counted live on this request.
  • shortfall — remote_order_count - local_order_count (never negative), or null when either side is unknown. A non-zero value means the import is still draining or fell short and should be re-run.

Authentication: Requires Bearer token.

Request​

Responses​

OK

Response Headers
    Content-Type