Skip to content

Trigger manual collection

POST
/api/v1/collect/trigger

Triggers an on-demand usage collection for specified buckets or all buckets. Rate limited to 1 request per 5 minutes per bucket.

Requires admin API key in X-API-Key header.

object
bucket_ids

Specific buckets to collect (omit for all)

Array<string>
force

Bypass rate limiting and skip checks

boolean

Collection triggered successfully

object
message
string
buckets_processed
integer
buckets_failed
integer
duration_seconds
number

Authentication required

object
error

Error message

string
request_id

Request ID for debugging

string
nullable
Example
{
"error": "Unauthorized"
}

Rate limited

object
error
string
Example
Rate limited
retry_after

Seconds until next request allowed

integer