Get home stats

Returns the dashboard counters, onboarding steps, recent orders, catalogs, and current-user tasks for the active workspace.

GET/api/home/stats

Returns the dashboard counters, onboarding steps, recent orders, catalogs, and current-user tasks for the active workspace.

Response Body

`application/json`

curl -X GET "https://loading/api/home/stats"

{
  "nSessions": 0,
  "nCustomers": 0,
  "nOrders": 0,
  "userName": "Ana",
  "catalogs": [
    {
      "id": "catalog_123",
      "title": "Retail catalog",
      "handle": "retail-catalog"
    }
  ],
  "myTasks": [
    {
      "id": "task_123",
      "title": "Follow up with supplier",
      "status": "pending"
    }
  ],
  "lastOrders": [
    {
      "id": "order_123",
      "number": "Q-1042",
      "status": "draft",
      "customerId": "customer_123",
      "updatedAt": "2026-03-20T10:00:00.000Z",
      "data": {
        "currencyCode": "USD",
        "total": 0
      }
    }
  ],
  "gettingStarted": {
    "enabled": true,
    "locale": "en",
    "steps": [
      {
        "id": "catalog-products",
        "icon": "package",
        "href": "/w/acme/objects/products/import",
        "done": false,
        "label": "Products",
        "title": "Import your products",
        "description": "Start by importing the product catalog you sell today.",
        "bullets": [
          "string"
        ]
      }
    ]
  }
}

{
  "_tag": "ApiBadRequestError",
  "code": "PRICE_IMPORT_DUPLICATE_SKUS",
  "message": "The request payload is invalid.",
  "description": "Remove duplicate SKU rows before importing the file.",
  "details": {}
}

{
  "_tag": "Unauthorized"
}

{
  "_tag": "ApiForbiddenError",
  "message": "You do not have permission to perform this action."
}

{
  "_tag": "ApiNotFoundError",
  "message": "The requested resource was not found."
}

{
  "_tag": "ApiConflictError",
  "message": "A resource with this handle already exists."
}

{
  "_tag": "ApiUnprocessableEntityError",
  "message": "The order cannot be submitted without items."
}

{
  "_tag": "ServiceUnavailable"
}

{
  "_tag": "ApiTimeoutError",
  "message": "The upstream operation timed out."
}

Get home stats

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

503application/json

504application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`