Analytics
Analytics - Buckets

Get Bucket Health

Changed on

Get bucket health monitoring metrics.

Analyzes bucket health including:

  • Error breakdown by type
  • Sync health per configuration
  • Stuck/failing syncs
  • Overall health status

Use Cases:

  • Monitor bucket health
  • Identify failing syncs
  • Debug errors by type
  • Alert on unhealthy buckets

Example:

curl -X GET "https://api.mixpeek.com/v1/analytics/buckets/bkt_abc123/health?hours=24" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "X-Namespace: your-namespace"
get/v1/analytics/buckets/{bucket_id}/health

Request

  • Base URL: https://api.mixpeek.com
  • URL: https://api.mixpeek.com/v1/analytics/buckets/{bucket_id}/health
  • Auth: HTTP bearer and API key in header X-Namespace

Path parameters

bucket_idstring required

Query parameters

hoursinteger

Hours of history

Response

Successful Response

bucket_idstring required

Bucket identifier

overall_healthstring required

Overall health status

total_errorsinteger required

Total error count

stuck_syncsstring[] required

Sync configs with no recent activity

Changes

  • 61a175e8eb9aRevision changes
    • warning

      removed the optional property from the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • 5d4c905106b4Revision changes
    • info

      the endpoint scheme security BearerAuth AND NamespaceHeader was added to the API