Get all snapshots for a date
GET /api/v1/snapshots/{date}
GET
/api/v1/snapshots/{date}
Returns usage snapshots for all clients on a specific date.
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ” date
required
string format: date
Example
2024-01-15Snapshot date (YYYY-MM-DD)
Query Parameters
Section titled “Query Parameters ” limit
integer
Maximum number of snapshots to return
Responses
Section titled “ Responses ”Snapshots for the date
object
snapshots
Array<object>
object
bucket_id
Client bucket identifier
string
snapshot_date
Date of the snapshot
string format: date
Example
2024-01-15 records
Record counts by collection type
object
person
integer
Example
15000 organisation
integer
Example
2500 member
integer
Example
8500 payment
integer
Example
45000 ticket
integer
Example
12000 booking
integer
Example
3200 total
integer
Example
125000 key
additional properties
integer
storage
S3 storage metrics
object
object_count
Total number of S3 objects
integer
Example
8500 total_bytes
Total storage in bytes
integer
Example
5368709120 by_prefix
Storage breakdown by S3 prefix
object
key
additional properties
object
count
integer
bytes
integer
computed_at
When the snapshot was computed
string format: date-time
count
integer
date
string format: date
Invalid request parameters
object
error
Error message
string
request_id
Request ID for debugging
string
Example
{ "error": "Invalid bucket_id"}Authentication required
object
error
Error message
string
request_id
Request ID for debugging
string
Example
{ "error": "Unauthorized"}