v5

latestOpenAPI 3.1.02026-08-025631,1012.8 MB

Bucket Syncs

Get Sync Metrics

Operational metrics for a sync in one call.

Folds config totals + health/staleness + the DLQ failure breakdown (grouped by normalized error reason) + the most-recent job's throughput into a single response — so callers can see "is this sync healthy / is anything backlogged" without stitching /jobs and /dlq or reading logs.

get/v1/buckets/{bucket_id}/syncs/{sync_config_id}/metrics

Path parameters

bucket_idstring required

sync_config_idstring required

Response

Successful Response

sync_config_idstring required

statusstring required

Sync config status (e.g. ACTIVE).

is_activeboolean required

pausedboolean

total_files_discoveredinteger

total_files_syncedinteger

total_files_failedinteger

batches_createdinteger

sync_run_counterinteger

consecutive_failuresinteger

last_errorstring nullable

last_sync_atstring date-time nullable

next_sync_atstring date-time nullable

seconds_since_last_syncinteger nullable

Age of last successful sync; None if never synced.

is_staleboolean

True when a continuous sync hasn't progressed within ~3x its polling interval.

failure_ratenumber

total_files_failed / total_files_discovered (0..1).

healthyboolean

Composite: active, not paused, no consecutive failures, not stale.

dlq_totalinteger

Objects stuck after all retries.

dlq_by_errorobject

DLQ counts grouped by normalized error reason (IDs stripped).

running_jobboolean

last_jobobject nullable

Summary of the most recent job: status, files_synced/failed, throughput_files_per_min, duration_seconds.