> ## 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 > Get usage and cost metrics. Analyzes bucket usage and costs including: - Storage costs (GB-hours) - Upload operation costs - Sync operation costs - Cost breakdown by category **Use Cases:** - Track bucket costs - Optimize spending - Forecast future costs - Cost attribution **Example:** ```bash curl -X GET "https://api.mixpeek.com/v1/analytics/buckets/bkt_abc123/usage?group_by=day" \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "X-Namespace: your-namespace" ``` ## 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: [] paths: /v1/analytics/buckets/{bucket_id}/usage: get: tags: - Analytics - Analytics - Buckets summary: Get Bucket Usage description: >- Get usage and cost metrics. Analyzes bucket usage and costs including: - Storage costs (GB-hours) - Upload operation costs - Sync operation costs - Cost breakdown by category **Use Cases:** - Track bucket costs - Optimize spending - Forecast future costs - Cost attribution **Example:** ```bash curl -X GET "https://api.mixpeek.com/v1/analytics/buckets/bkt_abc123/usage?group_by=day" \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "X-Namespace: your-namespace" ``` 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: 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: 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 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. 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. 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 ````