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

> A bucket's storage, upload and sync usage over time.

Per period: storage_gb_hours, the bytes the bucket held integrated over
time from its hourly storage snapshots (GB is 10^9 bytes; time before the
first snapshot in the window is not counted); upload_operations, the
objects created through the object create endpoints; and sync_operations,
the sync runs that finished, successful or failed. Objects a sync creates
count under its run, not as uploads.

Credits and estimated cost read 0: storage, uploads and syncs have no
price yet, and this route reports quantities until the invoice's price
table carries them. The default window is the last 30 days.



## OpenAPI

````yaml get /v1/analytics/buckets/{bucket_id}/usage
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:
  - BearerAuth: []
paths:
  /v1/analytics/buckets/{bucket_id}/usage:
    get:
      tags:
        - Analytics
        - Analytics - Buckets
      summary: Get Bucket Usage
      description: >-
        A bucket's storage, upload and sync usage over time.


        Per period: storage_gb_hours, the bytes the bucket held integrated over

        time from its hourly storage snapshots (GB is 10^9 bytes; time before
        the

        first snapshot in the window is not counted); upload_operations, the

        objects created through the object create endpoints; and
        sync_operations,

        the sync runs that finished, successful or failed. Objects a sync
        creates

        count under its run, not as uploads.


        Credits and estimated cost read 0: storage, uploads and syncs have no

        price yet, and this route reports quantities until the invoice's price

        table carries them. The default window is the last 30 days.
      operationId: get_bucket_usage_v1_analytics_buckets__bucket_id__usage_get
      parameters:
        - name: bucket_id
          in: path
          required: true
          schema:
            type: string
            title: Bucket Id
        - name: start_date
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                format: date-time
              - type: 'null'
            description: Start date (UTC)
            title: Start Date
          description: Start date (UTC)
        - name: end_date
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                format: date-time
              - type: 'null'
            description: End date (UTC)
            title: End Date
          description: End date (UTC)
        - name: group_by
          in: query
          required: false
          schema:
            type: string
            description: 'Time grouping: hour, day, week, month'
            default: day
            title: Group By
          description: 'Time grouping: hour, day, week, month'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BucketUsageResponse'
        '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: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '503':
          description: Service Unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - BearerAuth: []
          NamespaceHeader: []
components:
  schemas:
    BucketUsageResponse:
      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
        metrics:
          items:
            $ref: '#/components/schemas/UsageMetric'
          type: array
          title: Metrics
          description: Usage metrics
        cost_breakdown:
          $ref: '#/components/schemas/CostBreakdown'
          description: Cost breakdown
        total_credits:
          type: integer
          title: Total Credits
          description: Total credits consumed
        total_cost_usd:
          type: number
          title: Total Cost Usd
          description: Total cost in USD
      type: object
      required:
        - bucket_id
        - time_range
        - metrics
        - cost_breakdown
        - total_credits
        - total_cost_usd
      title: BucketUsageResponse
      description: Bucket usage and cost analytics 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
    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.
    UsageMetric:
      properties:
        time_bucket:
          type: string
          format: date-time
          title: Time Bucket
          description: Time bucket timestamp
        storage_gb_hours:
          type: number
          title: Storage Gb Hours
          description: Storage GB-hours
        upload_operations:
          type: integer
          title: Upload Operations
          description: Upload operation count
        sync_operations:
          type: integer
          title: Sync Operations
          description: Sync operation count
        total_credits:
          type: integer
          title: Total Credits
          description: Total credits consumed
        estimated_cost_usd:
          type: number
          title: Estimated Cost Usd
          description: Estimated cost in USD
      type: object
      required:
        - time_bucket
        - storage_gb_hours
        - upload_operations
        - sync_operations
        - total_credits
        - estimated_cost_usd
      title: UsageMetric
      description: Usage and cost metrics for a time bucket.
    CostBreakdown:
      properties:
        storage_percent:
          type: number
          title: Storage Percent
          description: Storage cost percentage
        upload_percent:
          type: number
          title: Upload Percent
          description: Upload cost percentage
        sync_percent:
          type: number
          title: Sync Percent
          description: Sync cost percentage
        other_percent:
          type: number
          title: Other Percent
          description: Other cost percentage
      type: object
      required:
        - storage_percent
        - upload_percent
        - sync_percent
        - other_percent
      title: CostBreakdown
      description: Cost breakdown by category.
    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.
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        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, malformed,
        unknown, revoked, inactive or expired key returns 401; a key without the
        permission, scope or plan an operation needs returns 403.
    NamespaceHeader:
      type: apiKey
      in: header
      name: X-Namespace
      description: >-
        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`.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.