Get Dashboard Metrics

GET 
/api/veracore/integration-instances/:integration_instance/dashboard

Get aggregate metrics for a Veracore integration instance.

Authorization

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

Returns:

• totalOrders — total Veracore orders stored for this instance.
• ordersByStatus — one entry per Veracore order status (all 13 statuses are always present, with count: 0 when empty): Unapproved, Unprocessed, Accepted, Hold, DeniedCredit, Pending, Processed, Picked, Backordered, PartiallyShipped, Shipped, Complete, Canceled.
• ordersLastSyncedAt / trackingLastSyncedAt — timestamps of the most recent order and tracking syncs.
• pendingReportTasks — report tasks still in created, polling, or done (awaiting processing) status.
• failedReportTasks — report tasks in failed status.
• unlinkedOrders — Veracore orders not yet linked to a SKU.io fulfillment.

All values are computed from locally stored data; no call is made to the Veracore API.

Errors

• 404 when the integration instance does not exist.

Authentication: Requires Bearer token.

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 — no record with the given identifier (or the route does not exist). Verify the ID before retrying.

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.