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

Get Sync Metrics

cURL

curl --request GET \
  --url https://api.mixpeek.com/v1/buckets/{bucket_id}/syncs/{sync_config_id}/metrics \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Namespace: <api-key>'

200

{
  "sync_config_id": "<string>",
  "status": "<string>",
  "is_active": true,
  "paused": false,
  "total_files_discovered": 0,
  "total_files_synced": 0,
  "total_files_failed": 0,
  "batches_created": 0,
  "sync_run_counter": 0,
  "consecutive_failures": 0,
  "last_error": "<string>",
  "last_sync_at": "2023-11-07T05:31:56Z",
  "next_sync_at": "2023-11-07T05:31:56Z",
  "seconds_since_last_sync": 123,
  "is_stale": false,
  "failure_rate": 0,
  "healthy": true,
  "dlq_total": 0,
  "dlq_by_error": {},
  "running_job": false,
  "last_job": {}
}

Authorizations

Authorization · string · header · required

Mixpeek API key, sent as Authorization: Bearer mxp_sk_.... Create one in Studio under Settings → API Keys, or with an admin key via POST /v1/organizations/users/{user_email}/api-keys. A missing header returns 403; an invalid or revoked key returns 401.

X-Namespace · string · header · required

Namespace id (ns_...), not the namespace name. This scopes the request rather than authenticating it, and it is required on every operation marked x-mixpeek-namespace-scoped.

Path Parameters

bucket_id · string · required

sync_config_id · string · required

Response

200

application/json

Successful Response

Operational metrics for a sync configuration, in one call.

Folds together what previously required stitching the config + /jobs + /dlq: lifetime totals, health/staleness, the DLQ failure breakdown (grouped by normalized error reason), and the most-recent job's throughput. Lets callers answer "is this sync healthy and is anything backlogged?" without circumventing the API with kubectl/log spelunking.

sync_config_id · string · required

status · string · required

Sync config status (e.g. ACTIVE).

is_active · boolean · required

paused · boolean · default: false

total_files_discovered · integer · default: 0

total_files_synced · integer · default: 0

total_files_failed · integer · default: 0

batches_created · integer · default: 0

sync_run_counter · integer · default: 0

consecutive_failures · integer · default: 0

last_error · string | null

last_sync_at · string<date-time> | null

next_sync_at · string<date-time> | null

seconds_since_last_sync · integer | null

Age of last successful sync; None if never synced.

is_stale · boolean · default: false

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

failure_rate · number · default: 0

total_files_failed / total_files_discovered (0..1).

healthy · boolean · default: true

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

dlq_total · integer · default: 0

Objects stuck after all retries.

dlq_by_error · Dlq By Error · object

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

Show child attributes

running_job · boolean · default: false

last_job · Last Job · object | null

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