Projects

Get project device counts

Get project device counts using Ovok’s Slim API.

MethodPath
GET/v1/slim/project/:id/device-counts

Authentication · Access policies

Returns summary counts of the devices in a project: total, assigned to a resident, active and by manufacturer. Use it for project overview tiles.

Auth: Bearer token. The caller's access policy must grant Device:search and Device:read (project admins skip this check). Scope: The project in the path. It must be the caller's project (from the token) or a direct child of it.

Request

Path parameters

NameTypeRequiredDescription
idstringYesProject id. Your own project or a direct child of it.

Behaviour

  • Counts come from the project's live device list, the same rows that back the live device views. That list is cached, so a device change can take a moment to show.
  • A row is left out when its device, resident, location or organization belongs to another project.
  • assignedResidentDeviceCount counts devices with a resident; unassignedDeviceCount is the rest.
  • activeDeviceCount counts devices whose latest telemetry reports them active; inactiveDeviceCount is the rest.
  • withingsDeviceCount counts devices whose serial number resolves to Withings. Every other device is counted in radarDeviceCount.
  • If the device list fails to build, the last complete list is used. When there is none, the route answers 503. When there is none, the route answers 503.

Example

curl -X GET 'https://api.sandbox.ovok.com/v1/slim/project/b7a3d915-6e20-4c8f-9a14-3d5f7b9c1e68/device-counts' \
  -H "Authorization: Bearer ${OVOK_TOKEN}"

Successful response

200 — Device counts retrieved successfully.

{
  "projectId": "b7a3d915-6e20-4c8f-9a14-3d5f7b9c1e68",
  "totalDeviceCount": 14,
  "assignedResidentDeviceCount": 11,
  "unassignedDeviceCount": 3,
  "activeDeviceCount": 12,
  "inactiveDeviceCount": 2,
  "radarDeviceCount": 10,
  "withingsDeviceCount": 4
}
FieldTypeDescription
projectIdstring (uuid)The project id from the path.
totalDeviceCountintegerDevices in the project.
assignedResidentDeviceCountintegerDevices with a resident.
unassignedDeviceCountintegerDevices without a resident.
activeDeviceCountintegerDevices that are currently active.
inactiveDeviceCountintegerDevices that are not active.
radarDeviceCountintegerDevices whose serial number does not resolve to Withings.
withingsDeviceCountintegerDevices whose serial number resolves to Withings.

Errors

StatusMeaning
400The project is neither the caller's project nor a direct child of it.
401The bearer token is missing or invalid.
403The session has no profile, or its access policy lacks Device:search or Device:read.
422id is empty.
503The device list cannot be built and no earlier complete list exists. Retry shortly.

Last updated on

On this page