Get client usage history

GET

/api/v1/clients/{bucket_id}/history

• Production
• Development

Returns historical usage snapshots for a client. Use date filters to narrow the time range.

Authorizations

• cookieAuth

Parameters

Path Parameters

bucket_id

required

string

/^[a-zA-Z0-9_-]{1,64}$/

Example

acme-corp

Client bucket identifier (alphanumeric, hyphens, underscores)

Query Parameters

start_date

string format: date

Example

2024-01-01

Start date for history range (YYYY-MM-DD)

end_date

string format: date

Example

2024-12-31

End date for history range (YYYY-MM-DD)

limit

integer

default: 30 >= 1 <= 1000

Maximum number of snapshots to return

Responses

200

Historical snapshots

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

Number of snapshots returned

integer

400

Invalid request parameters

object

error

Error message

string

request_id

Request ID for debugging

string

nullable

Example

{
  "error": "Invalid bucket_id"
}

401

Authentication required

object

error

Error message

string

request_id

Request ID for debugging

string

nullable

Example

{
  "error": "Unauthorized"
}

404

Resource not found

object

error

Error message

string

request_id

Request ID for debugging

string

nullable

Example

{
  "error": "Not found"
}