Read-only usage API
Public JSON reports for Slide Viewer. No sign-in or API key is needed. Names are replaced with stable anonymous labels before the response is returned.
GET https://usage.uom-bioimaging.uk/api/v1/usage
GET /api/v1/usage?from=2026-11-01&to=2026-11-19&affiliation=all
Filters
| Parameter | Values | Default |
|---|---|---|
| from | YYYY-MM-DD (UTC) | 29 days before today |
| to | YYYY-MM-DD (UTC) | Today |
| affiliation | all, manchester, external | all |
Dates are inclusive, from 2020 onwards, with a maximum range of 366 days and no future dates. Unknown or repeated parameters return HTTP 400. Results may be cached for 60 seconds.
Response
{
"version": 1,
"generated_at": "…",
"filters": { "from": "…", "to": "…", "affiliation": "all", "days": 30 },
"summary": { "sessions": 0, "users": 0, "anonymous_activity_days": 0,
"active_days": 0, "folder_opens": 0, "snapshots": 0, "slide_views": 0, "errors": 0 },
"daily": [{ "day": "…", "sessions": 0, "users": 0, "anonymous_activity_days": 0 }],
"features": [{ "action": "open_folder", "uses": 0, "users": 0 }],
"users": [{ "user": "User ABC123DEF456", "sessions": 0, "active_days": 0,
"folder_opens": 0, "snapshots": 0 }],
"users_truncated": false
}
The example above illustrates the structure, not actual data. Daily rows include zero-activity dates. User rows are limited to the 500 most active labels; users_truncated indicates if more exist. Summary and feature totals still include everyone.
users counts distinct supplied names, not verified people. Anonymous activity days are daily browser visits without a name; they contribute to totals but have no enduring user label. See the dashboard’s “What do these numbers mean?” for counting details.
Privacy and access
This API offers fixed reports only. It never returns actual names, normalized names, session IDs, browser visit IDs, or exact activity timestamps. Anonymous labels use a secret-keyed hash and stay consistent across reports. People choosing not to supply a name are not assigned an enduring label. The database retains its existing original records.
Only GET, HEAD and OPTIONS are accepted. Writes return HTTP 405. Arbitrary SQL is not accepted. Cross-origin reads are allowed. Unavailable reports return HTTP 503 with a safe error message; retry later.
Example request
curl 'https://usage.uom-bioimaging.uk/api/v1/usage?affiliation=manchester'