Projects
Get project device counts
Get project device counts using Ovok’s Slim API.
| Method | Path |
|---|---|
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
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | Project 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.
assignedResidentDeviceCountcounts devices with a resident;unassignedDeviceCountis the rest.activeDeviceCountcounts devices whose latest telemetry reports them active;inactiveDeviceCountis the rest.withingsDeviceCountcounts devices whose serial number resolves to Withings. Every other device is counted inradarDeviceCount.- 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
}| Field | Type | Description |
|---|---|---|
projectId | string (uuid) | The project id from the path. |
totalDeviceCount | integer | Devices in the project. |
assignedResidentDeviceCount | integer | Devices with a resident. |
unassignedDeviceCount | integer | Devices without a resident. |
activeDeviceCount | integer | Devices that are currently active. |
inactiveDeviceCount | integer | Devices that are not active. |
radarDeviceCount | integer | Devices whose serial number does not resolve to Withings. |
withingsDeviceCount | integer | Devices whose serial number resolves to Withings. |
Errors
| Status | Meaning |
|---|---|
400 | The project is neither the caller's project nor a direct child of it. |
401 | The bearer token is missing or invalid. |
403 | The session has no profile, or its access policy lacks Device:search or Device:read. |
422 | id is empty. |
503 | The device list cannot be built and no earlier complete list exists. Retry shortly. |
Last updated on