Get the dashboard summary

Request#

GET /api/v1/dashboard

Requires reports:read and all four inventory Read permissions: assets:read, people:read, locations:read, and subscriptions:read. See dashboard report permissions.

Send Authorization: Bearer YOUR_API_TOKEN and Accept: application/json.

Query parameters#

This endpoint does not use query parameters.

Example#

Set ASSETCENTER_API_TOKEN as described in the quick start. Replace example record and option IDs with values from your organization.

curl --request GET "https://my.assetcenter.app/api/v1/dashboard" \
  --header "Authorization: Bearer $ASSETCENTER_API_TOKEN" \
  --header "Accept: application/json"

Response#

200 OK.

{
  "data": {
    "organization_id": 12,
    "counts": {
      "assets": {
        "available": 140,
        "deployed": 312,
        "decommissioned": 18
      },
      "people": {
        "active": 96,
        "inactive": 7
      },
      "locations": {
        "active": 11
      },
      "subscriptions": {
        "available": 3,
        "deployed": 24,
        "paused": 1
      }
    }
  }
}

Behavior and constraints#

counts has one object per record type, mapping each status to its number of records. Statuses with no records are left out, so treat a missing status as 0. Asset statuses are available, deployed, and decommissioned; people and locations are active or inactive; subscriptions are available, deployed, paused, cancelled, or retired. The same counts are available from dashboard status counts.

Errors#

401 means the token is missing, expired, revoked, or not a customer API token. 403 means a required permission or administrator access is missing. 422 identifies invalid or unsupported input; inspect the errors object when present. 429 means a rate limit was reached. See error handling and rate limits.