Photo Collect API
Photo Collect ↗
GETOperations

Get usage report

Return upload, export, failure, deletion, and SMS usage for every accessible site.

GET/apiv1/usagereport

The authenticated user needs the admin or reporting role. Date boundaries are inclusive and interpreted in the configured report timezone. Sites with zero usage are included.

Request parameters

Parameter Required Description
from No Inclusive start in YYYY-MM-DD; defaults to nine days before to.
to No Inclusive end in YYYY-MM-DD; defaults to today.

Response

{
  "from": "2026-07-01",
  "to": "2026-07-10",
  "timezone": "Europe/Zurich",
  "total": {
    "uploaded": 42,
    "exported": 35,
    "failed": 4,
    "deleted": 3,
    "sms_segments": 18
  },
  "sites": [
    {
      "site_code": "example",
      "site_name": "Example Site",
      "uploaded": 42,
      "exported": 35,
      "failed": 4,
      "deleted": 3,
      "sms_segments": 18
    }
  ]
}

Invalid or reversed dates return HTTP 400 with INVALID_DATE or INVALID_DATE_RANGE. Authentication or permission failures return HTTP 401 with ACCESS_DENIED.

⌁

Connect your API

Credentials are kept in this session only.