adminDashboard

Requires a tenant administrator.

Returns the administrator's overview of the organization: system overview, user activity, system health, security metrics, module usage, integrations and notifications. Only admins and owners can read it.

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 AdminDashboard {
  adminDashboard {
    integrations {
      name
      status
      lastSync
      recordsSynced
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query AdminDashboard {\n  adminDashboard {\n    integrations {\n      name\n      status\n      lastSync\n      recordsSynced\n    }\n  }\n}"
}
EOF

Response:

{
  "data": {
    "adminDashboard": {
      "integrations": [
        {
          "name": "string",
          "status": "string",
          "lastSync": "2025-01-15T00:00:00Z",
          "recordsSynced": 0
        }
      ]
    }
  }
}

adminDashboard: AdminDashboard!

Type

AdminDashboard object

The admin dashboard.