Skip to main content

Get Instance Dashboard

GET 
/api/magento2/integration-instances/:magento2IntegrationInstance/dashboard

Dashboard metrics for a single Magento 2 integration instance. Backs the shared <SalesChannelInstanceDashboard> component on /v2/integrations/magento2/dashboard.

Not yet available to API tokens

This endpoint currently requires session authentication; Personal Access Token scope support is in progress.

Returns a hybrid payload: snake_case fields kept for legacy Magento2DashboardMetrics fallbacks, plus the camelCase SalesChannelInstanceDashboardData contract (syncCards, integrations, entityCounts, financialSummary, syncStatus) consumed directly by the dashboard component.

financialSummary.currency is the store's base currency code (e.g. USD) that grossRevenue, totalRefunds and netRevenue are in. Store views can sell in different currencies, so the three amounts are summed in base currency (Magento's base_grand_total / base_total_refunded); the code is the latest order's base_currency_code, else the latest order's currency_code, else USD. The legacy top-level currency carries the same value.

Path params:

  • magento2IntegrationInstance (required, integer) — Magento 2 IntegrationInstance ID.

Query params:

  • period (optional, string, default 30d) — reporting window for financialSummary / revenue_30d. One of: today, 7d, 30d, 90d, All.

Error responses:

  • 404 — instance ID does not exist in this tenant.
  • 422 — period is not one of the allowed values.
  • 401 — caller is not authenticated.

Request​

Responses​

OK

Response Headers
    Content-Type