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.

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.

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

200

OK

Response Headers

Content-Type

401

Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.

403

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.

404

Not Found

Response Headers

Content-Type

422

Unprocessable Entity

Response Headers

Content-Type

429

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.