> ## 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.

# Get Bucket Health

> 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:**
```bash
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"
```



## OpenAPI

````yaml get /v1/analytics/buckets/{bucket_id}/health
openapi: 3.1.0
info:
  title: Mixpeek API
  description: >-
    This is the Mixpeek API, providing access to various endpoints for data
    processing and retrieval.
  termsOfService: https://mixpeek.com/terms
  contact:
    name: Mixpeek Support
    url: https://mixpeek.com/contact
    email: info@mixpeek.com
  version: '0.82'
servers:
  - url: https://api.mixpeek.com
    description: Production
security: []
paths:
  /v1/analytics/buckets/{bucket_id}/health:
    get:
      tags:
        - Analytics
        - Analytics - Buckets
      summary: Get Bucket Health
      description: >-
        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:**

        ```bash

        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"
        ```
      operationId: get_bucket_health_v1_analytics_buckets__bucket_id__health_get
      parameters:
        - name: bucket_id
          in: path
          required: true
          schema:
            type: string
            title: Bucket Id
        - name: hours
          in: query
          required: false
          schema:
            type: integer
            maximum: 720
            minimum: 1
            description: Hours of history
            default: 24
            title: Hours
          description: Hours of history
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BucketHealthResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    BucketHealthResponse:
      properties:
        bucket_id:
          type: string
          title: Bucket Id
          description: Bucket identifier
        time_range:
          $ref: '#/components/schemas/api__analytics__buckets__models__TimeRange'
          description: Query time range
        overall_health:
          type: string
          title: Overall Health
          description: Overall health status
        total_errors:
          type: integer
          title: Total Errors
          description: Total error count
        error_breakdown:
          items:
            $ref: '#/components/schemas/ErrorBreakdown'
          type: array
          title: Error Breakdown
          description: Errors by type
        sync_health:
          items:
            $ref: '#/components/schemas/SyncHealthMetric'
          type: array
          title: Sync Health
          description: Sync health per config
        stuck_syncs:
          items:
            type: string
          type: array
          title: Stuck Syncs
          description: Sync configs with no recent activity
      type: object
      required:
        - bucket_id
        - time_range
        - overall_health
        - total_errors
        - error_breakdown
        - sync_health
        - stuck_syncs
      title: BucketHealthResponse
      description: Bucket health monitoring response.
    ErrorResponse:
      properties:
        success:
          type: boolean
          title: Success
          description: Always false for error responses
          default: false
        status:
          type: integer
          title: Status
          description: HTTP status code for this error
        error:
          $ref: '#/components/schemas/ErrorDetail'
          description: Error details payload
      type: object
      required:
        - status
        - error
      title: ErrorResponse
      description: Error response model.
      examples:
        - error:
            details:
              id: ns_123
              resource: namespace
            message: Namespace not found
            type: NotFoundError
          status: 404
          success: false
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    api__analytics__buckets__models__TimeRange:
      properties:
        start:
          type: string
          format: date-time
          title: Start
          description: Start of time range
        end:
          type: string
          format: date-time
          title: End
          description: End of time range
      type: object
      required:
        - start
        - end
      title: TimeRange
      description: Time range for analytics queries.
    ErrorBreakdown:
      properties:
        error_type:
          type: string
          title: Error Type
          description: Error type
        count:
          type: integer
          title: Count
          description: Error count
        percentage:
          type: number
          title: Percentage
          description: Percentage of total errors
        first_seen:
          type: string
          format: date-time
          title: First Seen
          description: First occurrence
        last_seen:
          type: string
          format: date-time
          title: Last Seen
          description: Last occurrence
      type: object
      required:
        - error_type
        - count
        - percentage
        - first_seen
        - last_seen
      title: ErrorBreakdown
      description: Error breakdown by type.
    SyncHealthMetric:
      properties:
        sync_config_id:
          type: string
          title: Sync Config Id
          description: Sync config identifier
        consecutive_failures:
          type: integer
          title: Consecutive Failures
          description: Consecutive failure count
        last_success_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Last Success At
          description: Last successful sync
        last_failure_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Last Failure At
          description: Last failed sync
        failure_rate:
          type: number
          title: Failure Rate
          description: Failure rate (0-1)
      type: object
      required:
        - sync_config_id
        - consecutive_failures
        - failure_rate
      title: SyncHealthMetric
      description: Sync health metrics per config.
    ErrorDetail:
      properties:
        message:
          type: string
          title: Message
          description: Human-readable error message
        type:
          type: string
          title: Type
          description: Stable error type identifier (machine-readable)
        code:
          anyOf:
            - type: string
            - type: 'null'
          title: Code
          description: >-
            Fine-grained error code for programmatic handling (e.g.,
            namespace_name_taken, feature_extractor_not_found). Present only
            when consumers may need to branch on a specific error condition.
        details:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Details
          description: >-
            Optional structured details to help debugging (validation errors,
            IDs, etc.)
      type: object
      required:
        - message
        - type
      title: ErrorDetail
      description: Error detail model.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError

````