Skip to main content
GET
/
v1
/
analytics
/
buckets
/
{bucket_id}
/
health
Get Bucket Health
curl --request GET \
  --url https://api.mixpeek.com/v1/analytics/buckets/{bucket_id}/health
{
  "bucket_id": "<string>",
  "time_range": {
    "start": "2023-11-07T05:31:56Z",
    "end": "2023-11-07T05:31:56Z"
  },
  "overall_health": "<string>",
  "total_errors": 123,
  "error_breakdown": [
    {
      "error_type": "<string>",
      "count": 123,
      "percentage": 123,
      "first_seen": "2023-11-07T05:31:56Z",
      "last_seen": "2023-11-07T05:31:56Z"
    }
  ],
  "sync_health": [
    {
      "sync_config_id": "<string>",
      "consecutive_failures": 123,
      "failure_rate": 123,
      "last_success_at": "2023-11-07T05:31:56Z",
      "last_failure_at": "2023-11-07T05:31:56Z"
    }
  ],
  "stuck_syncs": [
    "<string>"
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.mixpeek.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Headers

​
Authorization
string

Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings.

Example:

"Bearer YOUR_MIXPEEK_API_KEY"

​
authorization
string
​
X-Namespace
string

Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like 'my-namespace'. Falls back to ?namespace= query parameter if the header is omitted.

Examples:

"ns_abc123def456"

"production"

"my-namespace"

Path Parameters

​
bucket_id
string
required

Query Parameters

​
hours
integer
default:24

Hours of history

Required range: 1 <= x <= 720

Response

Successful Response

Bucket health monitoring response.

​
bucket_id
string
required

Bucket identifier

​
time_range
TimeRange · object
required

Query time range

​
overall_health
string
required

Overall health status

​
total_errors
integer
required

Total error count

​
error_breakdown
ErrorBreakdown · object[]
required

Errors by type

​
sync_health
SyncHealthMetric · object[]
required

Sync health per config

​
stuck_syncs
string[]
required

Sync configs with no recent activity