dashboardHome

Requires an authenticated session.

The figures for the dashboard home screen over a date range, limited to what your role may see: sales reps see their own records, admins see everything by default, and other staff see their team.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

query DashboardHome($range: AnalyticsRangeInput!) {
  dashboardHome(range: $range) {
    scope
    actionQueue {
      draftQuotes
      ordersAwaitingFulfilment
      overdueInvoices
      pendingApprovals
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query DashboardHome($range: AnalyticsRangeInput!) {\n  dashboardHome(range: $range) {\n    scope\n    actionQueue {\n      draftQuotes\n      ordersAwaitingFulfilment\n      overdueInvoices\n      pendingApprovals\n    }\n  }\n}",
  "variables": {
    "range": {
      "from": "2025-01-15T00:00:00Z",
      "to": "2025-01-15T00:00:00Z"
    }
  }
}
EOF

Variables:

{
  "range": {
    "from": "2025-01-15T00:00:00Z",
    "to": "2025-01-15T00:00:00Z"
  }
}

Response:

{
  "data": {
    "dashboardHome": {
      "scope": "ALL",
      "actionQueue": {
        "draftQuotes": 0,
        "ordersAwaitingFulfilment": 0,
        "overdueInvoices": 0,
        "pendingApprovals": 0
      }
    }
  }
}

dashboardHome(
  range: AnalyticsRangeInput!
): DashboardHome!

Arguments

dashboardHome.range ● AnalyticsRangeInput! non-null input

The date range and, optionally, the visibility scope.

Type

DashboardHome object

What the home dashboard shows.