AnalyticsApi.md

# mixpeek.AnalyticsApi

All URIs are relative to *https://api.mixpeek.com*

Method | HTTP request | Description
------------- | ------------- | -------------
[**analyze_bottlenecks_analytics_performance_engine**](AnalyticsApi.md#analyze_bottlenecks_analytics_performance_engine) | **GET** /v1/analytics/performance/engine/bottlenecks | Analyze Bottlenecks
[**analyze_bottlenecks_analytics_performance_engine_0**](AnalyticsApi.md#analyze_bottlenecks_analytics_performance_engine_0) | **GET** /v1/analytics/performance/engine/bottlenecks | Analyze Bottlenecks
[**analyze_for_tuning_analytics_retrievers**](AnalyticsApi.md#analyze_for_tuning_analytics_retrievers) | **POST** /v1/analytics/retrievers/{retriever_id}/analyze-tuning | Analyze For Tuning
[**analyze_for_tuning_analytics_retrievers_0**](AnalyticsApi.md#analyze_for_tuning_analytics_retrievers_0) | **POST** /v1/analytics/retrievers/{retriever_id}/analyze-tuning | Analyze For Tuning
[**get_assignment_metrics_analytics_taxonomies_taxonomy**](AnalyticsApi.md#get_assignment_metrics_analytics_taxonomies_taxonomy) | **GET** /v1/analytics/taxonomies/{taxonomy_id}/assignments | Get Assignment Metrics
[**get_assignment_metrics_analytics_taxonomies_taxonomy_0**](AnalyticsApi.md#get_assignment_metrics_analytics_taxonomies_taxonomy_0) | **GET** /v1/analytics/taxonomies/{taxonomy_id}/assignments | Get Assignment Metrics
[**get_batch_diagnostics_analytics_performance_batches**](AnalyticsApi.md#get_batch_diagnostics_analytics_performance_batches) | **GET** /v1/analytics/performance/batches/{batch_id}/diagnostics | Get Batch Diagnostics
[**get_batch_diagnostics_analytics_performance_batches_0**](AnalyticsApi.md#get_batch_diagnostics_analytics_performance_batches_0) | **GET** /v1/analytics/performance/batches/{batch_id}/diagnostics | Get Batch Diagnostics
[**get_bucket_health_analytics**](AnalyticsApi.md#get_bucket_health_analytics) | **GET** /v1/analytics/buckets/{bucket_id}/health | Get Bucket Health
[**get_bucket_health_analytics_0**](AnalyticsApi.md#get_bucket_health_analytics_0) | **GET** /v1/analytics/buckets/{bucket_id}/health | Get Bucket Health
[**get_bucket_storage_analytics**](AnalyticsApi.md#get_bucket_storage_analytics) | **GET** /v1/analytics/buckets/{bucket_id}/storage | Get Bucket Storage
[**get_bucket_storage_analytics_0**](AnalyticsApi.md#get_bucket_storage_analytics_0) | **GET** /v1/analytics/buckets/{bucket_id}/storage | Get Bucket Storage
[**get_bucket_usage_analytics**](AnalyticsApi.md#get_bucket_usage_analytics) | **GET** /v1/analytics/buckets/{bucket_id}/usage | Get Bucket Usage
[**get_bucket_usage_analytics_0**](AnalyticsApi.md#get_bucket_usage_analytics_0) | **GET** /v1/analytics/buckets/{bucket_id}/usage | Get Bucket Usage
[**get_cache_performance_analytics_retrievers**](AnalyticsApi.md#get_cache_performance_analytics_retrievers) | **GET** /v1/analytics/retrievers/{retriever_id}/cache-performance | Get Cache Performance
[**get_cache_performance_analytics_retrievers_0**](AnalyticsApi.md#get_cache_performance_analytics_retrievers_0) | **GET** /v1/analytics/retrievers/{retriever_id}/cache-performance | Get Cache Performance
[**get_collection_overview_analytics**](AnalyticsApi.md#get_collection_overview_analytics) | **GET** /v1/analytics/collections/{collection_id}/overview | Get Collection Overview
[**get_collection_overview_analytics_0**](AnalyticsApi.md#get_collection_overview_analytics_0) | **GET** /v1/analytics/collections/{collection_id}/overview | Get Collection Overview
[**get_compound_index_patterns_analytics_namespaces_indexes**](AnalyticsApi.md#get_compound_index_patterns_analytics_namespaces_indexes) | **GET** /v1/analytics/namespaces/indexes/compound-patterns | Get Compound Index Patterns
[**get_compound_index_patterns_analytics_namespaces_indexes_0**](AnalyticsApi.md#get_compound_index_patterns_analytics_namespaces_indexes_0) | **GET** /v1/analytics/namespaces/indexes/compound-patterns | Get Compound Index Patterns
[**get_confidence_distribution_analytics_taxonomies_taxonomy**](AnalyticsApi.md#get_confidence_distribution_analytics_taxonomies_taxonomy) | **GET** /v1/analytics/taxonomies/{taxonomy_id}/confidence | Get Confidence Distribution
[**get_confidence_distribution_analytics_taxonomies_taxonomy_0**](AnalyticsApi.md#get_confidence_distribution_analytics_taxonomies_taxonomy_0) | **GET** /v1/analytics/taxonomies/{taxonomy_id}/confidence | Get Confidence Distribution
[**get_document_growth_analytics**](AnalyticsApi.md#get_document_growth_analytics) | **GET** /v1/analytics/collections/{collection_id}/growth | Get Document Growth
[**get_document_growth_analytics_0**](AnalyticsApi.md#get_document_growth_analytics_0) | **GET** /v1/analytics/collections/{collection_id}/growth | Get Document Growth
[**get_engine_performance_analytics**](AnalyticsApi.md#get_engine_performance_analytics) | **GET** /v1/analytics/performance/engine | Get Engine Performance
[**get_engine_performance_analytics_0**](AnalyticsApi.md#get_engine_performance_analytics_0) | **GET** /v1/analytics/performance/engine | Get Engine Performance
[**get_engine_stage_breakdown_analytics_performance**](AnalyticsApi.md#get_engine_stage_breakdown_analytics_performance) | **GET** /v1/analytics/performance/engine/stages | Get Engine Stage Breakdown
[**get_engine_stage_breakdown_analytics_performance_0**](AnalyticsApi.md#get_engine_stage_breakdown_analytics_performance_0) | **GET** /v1/analytics/performance/engine/stages | Get Engine Stage Breakdown
[**get_enrichment_history_analytics_taxonomies_taxonomy**](AnalyticsApi.md#get_enrichment_history_analytics_taxonomies_taxonomy) | **GET** /v1/analytics/taxonomies/{taxonomy_id}/enrichments | Get Enrichment History
[**get_enrichment_history_analytics_taxonomies_taxonomy_0**](AnalyticsApi.md#get_enrichment_history_analytics_taxonomies_taxonomy_0) | **GET** /v1/analytics/taxonomies/{taxonomy_id}/enrichments | Get Enrichment History
[**get_execution_history_analytics_clusters**](AnalyticsApi.md#get_execution_history_analytics_clusters) | **GET** /v1/analytics/clusters/{cluster_id}/execution-history | Get Execution History
[**get_execution_history_analytics_clusters_0**](AnalyticsApi.md#get_execution_history_analytics_clusters_0) | **GET** /v1/analytics/clusters/{cluster_id}/execution-history | Get Execution History
[**get_extractor_breakdown_analytics_performance_engine**](AnalyticsApi.md#get_extractor_breakdown_analytics_performance_engine) | **GET** /v1/analytics/performance/engine/extractors | Get Extractor Breakdown
[**get_extractor_breakdown_analytics_performance_engine_0**](AnalyticsApi.md#get_extractor_breakdown_analytics_performance_engine_0) | **GET** /v1/analytics/performance/engine/extractors | Get Extractor Breakdown
[**get_extractor_performance_analytics**](AnalyticsApi.md#get_extractor_performance_analytics) | **GET** /v1/analytics/extractors/performance | Get Extractor Performance
[**get_extractor_performance_analytics_0**](AnalyticsApi.md#get_extractor_performance_analytics_0) | **GET** /v1/analytics/extractors/performance | Get Extractor Performance
[**get_extractor_performance_analytics_1**](AnalyticsApi.md#get_extractor_performance_analytics_1) | **GET** /v1/analytics/collections/{collection_id}/extractors | Get Extractor Performance
[**get_extractor_performance_analytics_2**](AnalyticsApi.md#get_extractor_performance_analytics_2) | **GET** /v1/analytics/collections/{collection_id}/extractors | Get Extractor Performance
[**get_failure_analysis_analytics**](AnalyticsApi.md#get_failure_analysis_analytics) | **GET** /v1/analytics/collections/{collection_id}/failures | Get Failure Analysis
[**get_failure_analysis_analytics_0**](AnalyticsApi.md#get_failure_analysis_analytics_0) | **GET** /v1/analytics/collections/{collection_id}/failures | Get Failure Analysis
[**get_failure_analysis_analytics_clusters**](AnalyticsApi.md#get_failure_analysis_analytics_clusters) | **GET** /v1/analytics/clusters/{cluster_id}/failures | Get Failure Analysis
[**get_failure_analysis_analytics_clusters_0**](AnalyticsApi.md#get_failure_analysis_analytics_clusters_0) | **GET** /v1/analytics/clusters/{cluster_id}/failures | Get Failure Analysis
[**get_field_performance_analytics_namespaces**](AnalyticsApi.md#get_field_performance_analytics_namespaces) | **GET** /v1/analytics/namespaces/fields/performance | Get Field Performance
[**get_field_performance_analytics_namespaces_0**](AnalyticsApi.md#get_field_performance_analytics_namespaces_0) | **GET** /v1/analytics/namespaces/fields/performance | Get Field Performance
[**get_field_usage_analytics_indexes**](AnalyticsApi.md#get_field_usage_analytics_indexes) | **GET** /v1/analytics/indexes/usage | Get Field Usage
[**get_field_usage_analytics_indexes_0**](AnalyticsApi.md#get_field_usage_analytics_indexes_0) | **GET** /v1/analytics/indexes/usage | Get Field Usage
[**get_index_recommendations_analytics_namespaces_indexes**](AnalyticsApi.md#get_index_recommendations_analytics_namespaces_indexes) | **GET** /v1/analytics/namespaces/indexes/recommendations | Get Index Recommendations
[**get_index_recommendations_analytics_namespaces_indexes_0**](AnalyticsApi.md#get_index_recommendations_analytics_namespaces_indexes_0) | **GET** /v1/analytics/namespaces/indexes/recommendations | Get Index Recommendations
[**get_index_suggestions_analytics_indexes**](AnalyticsApi.md#get_index_suggestions_analytics_indexes) | **GET** /v1/analytics/indexes/suggestions | Get Index Suggestions
[**get_index_suggestions_analytics_indexes_0**](AnalyticsApi.md#get_index_suggestions_analytics_indexes_0) | **GET** /v1/analytics/indexes/suggestions | Get Index Suggestions
[**get_inference_performance_analytics**](AnalyticsApi.md#get_inference_performance_analytics) | **GET** /v1/analytics/inference/performance | Get Inference Performance
[**get_inference_performance_analytics_0**](AnalyticsApi.md#get_inference_performance_analytics_0) | **GET** /v1/analytics/inference/performance | Get Inference Performance
[**get_label_distribution_analytics_taxonomies_taxonomy**](AnalyticsApi.md#get_label_distribution_analytics_taxonomies_taxonomy) | **GET** /v1/analytics/taxonomies/{taxonomy_id}/labels | Get Label Distribution
[**get_label_distribution_analytics_taxonomies_taxonomy_0**](AnalyticsApi.md#get_label_distribution_analytics_taxonomies_taxonomy_0) | **GET** /v1/analytics/taxonomies/{taxonomy_id}/labels | Get Label Distribution
[**get_latency_metrics_analytics**](AnalyticsApi.md#get_latency_metrics_analytics) | **GET** /v1/analytics/collections/{collection_id}/latency | Get Latency Metrics
[**get_latency_metrics_analytics_0**](AnalyticsApi.md#get_latency_metrics_analytics_0) | **GET** /v1/analytics/collections/{collection_id}/latency | Get Latency Metrics
[**get_most_queried_fields_analytics_namespaces**](AnalyticsApi.md#get_most_queried_fields_analytics_namespaces) | **GET** /v1/analytics/namespaces/fields/most-queried | Get Most Queried Fields
[**get_most_queried_fields_analytics_namespaces_0**](AnalyticsApi.md#get_most_queried_fields_analytics_namespaces_0) | **GET** /v1/analytics/namespaces/fields/most-queried | Get Most Queried Fields
[**get_namespace_summary_analytics**](AnalyticsApi.md#get_namespace_summary_analytics) | **GET** /v1/analytics/namespaces/summary | Get Namespace Summary
[**get_namespace_summary_analytics_0**](AnalyticsApi.md#get_namespace_summary_analytics_0) | **GET** /v1/analytics/namespaces/summary | Get Namespace Summary
[**get_retriever_performance_analytics**](AnalyticsApi.md#get_retriever_performance_analytics) | **GET** /v1/analytics/retrievers/{retriever_id}/performance | Get Retriever Performance
[**get_retriever_performance_analytics_0**](AnalyticsApi.md#get_retriever_performance_analytics_0) | **GET** /v1/analytics/retrievers/{retriever_id}/performance | Get Retriever Performance
[**get_retriever_signals_analytics**](AnalyticsApi.md#get_retriever_signals_analytics) | **GET** /v1/analytics/retrievers/{retriever_id}/signals | Get Retriever Signals
[**get_retriever_signals_analytics_0**](AnalyticsApi.md#get_retriever_signals_analytics_0) | **GET** /v1/analytics/retrievers/{retriever_id}/signals | Get Retriever Signals
[**get_slow_queries_analytics_namespaces**](AnalyticsApi.md#get_slow_queries_analytics_namespaces) | **GET** /v1/analytics/namespaces/queries/slow | Get Slow Queries
[**get_slow_queries_analytics_namespaces_0**](AnalyticsApi.md#get_slow_queries_analytics_namespaces_0) | **GET** /v1/analytics/namespaces/queries/slow | Get Slow Queries
[**get_slowest_operations_analytics_performance_engine_slow**](AnalyticsApi.md#get_slowest_operations_analytics_performance_engine_slow) | **GET** /v1/analytics/performance/engine/slow-operations | Get Slowest Operations
[**get_slowest_operations_analytics_performance_engine_slow_0**](AnalyticsApi.md#get_slowest_operations_analytics_performance_engine_slow_0) | **GET** /v1/analytics/performance/engine/slow-operations | Get Slowest Operations
[**get_slowest_queries_analytics_retrievers_id_slow**](AnalyticsApi.md#get_slowest_queries_analytics_retrievers_id_slow) | **GET** /v1/analytics/retrievers/{retriever_id}/slow-queries | Get Slowest Queries
[**get_slowest_queries_analytics_retrievers_id_slow_0**](AnalyticsApi.md#get_slowest_queries_analytics_retrievers_id_slow_0) | **GET** /v1/analytics/retrievers/{retriever_id}/slow-queries | Get Slowest Queries
[**get_stage_breakdown_analytics_retrievers**](AnalyticsApi.md#get_stage_breakdown_analytics_retrievers) | **GET** /v1/analytics/retrievers/{retriever_id}/stages | Get Stage Breakdown
[**get_stage_breakdown_analytics_retrievers_0**](AnalyticsApi.md#get_stage_breakdown_analytics_retrievers_0) | **GET** /v1/analytics/retrievers/{retriever_id}/stages | Get Stage Breakdown
[**get_sync_comparison_analytics_buckets**](AnalyticsApi.md#get_sync_comparison_analytics_buckets) | **GET** /v1/analytics/buckets/{bucket_id}/sync-comparison | Get Sync Comparison
[**get_sync_comparison_analytics_buckets_0**](AnalyticsApi.md#get_sync_comparison_analytics_buckets_0) | **GET** /v1/analytics/buckets/{bucket_id}/sync-comparison | Get Sync Comparison
[**get_sync_performance_analytics_buckets**](AnalyticsApi.md#get_sync_performance_analytics_buckets) | **GET** /v1/analytics/buckets/{bucket_id}/sync-performance | Get Sync Performance
[**get_sync_performance_analytics_buckets_0**](AnalyticsApi.md#get_sync_performance_analytics_buckets_0) | **GET** /v1/analytics/buckets/{bucket_id}/sync-performance | Get Sync Performance
[**get_upload_performance_analytics_buckets**](AnalyticsApi.md#get_upload_performance_analytics_buckets) | **GET** /v1/analytics/buckets/{bucket_id}/upload-performance | Get Upload Performance
[**get_upload_performance_analytics_buckets_0**](AnalyticsApi.md#get_upload_performance_analytics_buckets_0) | **GET** /v1/analytics/buckets/{bucket_id}/upload-performance | Get Upload Performance
[**get_usage_summary_analytics**](AnalyticsApi.md#get_usage_summary_analytics) | **GET** /v1/analytics/usage/summary | Get Usage Summary
[**get_usage_summary_analytics_0**](AnalyticsApi.md#get_usage_summary_analytics_0) | **GET** /v1/analytics/usage/summary | Get Usage Summary


# **analyze_bottlenecks_analytics_performance_engine**
> BottleneckResponse analyze_bottlenecks_analytics_performance_engine(hours=hours, limit=limit, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)

Analyze Bottlenecks

Identify performance bottlenecks.

Analyzes profiling data to identify the biggest bottlenecks,
ranked by total time spent.

**Use Cases:**
- Find what's slowing down your pipelines
- Prioritize optimization efforts
- Monitor bottleneck trends

**Ranking:**
- Sorted by total time spent (sum across all executions)
- Shows percentage of total execution time
- Includes execution count and average time

**Example:**
```bash
GET /v1/analytics/performance/engine/bottlenecks?hours=24&limit=10
```

### Example


```python
import mixpeek
from mixpeek.models.bottleneck_response import BottleneckResponse
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.AnalyticsApi(api_client)
    hours = 24 # int | Hours of history (optional) (default to 24)
    limit = 10 # int | Number of bottlenecks to return (optional) (default to 10)
    authorization = 'authorization_example' # str | REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. (optional)
    authorization2 = 'authorization_example' # str |  (optional)
    x_namespace = 'x_namespace_example' # str | REQUIRED: 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' (optional)

    try:
        # Analyze Bottlenecks
        api_response = api_instance.analyze_bottlenecks_analytics_performance_engine(hours=hours, limit=limit, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)
        print("The response of AnalyticsApi->analyze_bottlenecks_analytics_performance_engine:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AnalyticsApi->analyze_bottlenecks_analytics_performance_engine: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **hours** | **int**| Hours of history | [optional] [default to 24]
 **limit** | **int**| Number of bottlenecks to return | [optional] [default to 10]
 **authorization** | **str**| REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. | [optional] 
 **authorization2** | **str**|  | [optional] 
 **x_namespace** | **str**| REQUIRED: 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' | [optional] 

### Return type

[**BottleneckResponse**](BottleneckResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**400** | Bad Request |  -  |
**401** | Unauthorized |  -  |
**403** | Forbidden |  -  |
**404** | Not Found |  -  |
**422** | Validation Error |  -  |
**500** | Internal Server Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **analyze_bottlenecks_analytics_performance_engine_0**
> BottleneckResponse analyze_bottlenecks_analytics_performance_engine_0(hours=hours, limit=limit, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)

Analyze Bottlenecks

Identify performance bottlenecks.

Analyzes profiling data to identify the biggest bottlenecks,
ranked by total time spent.

**Use Cases:**
- Find what's slowing down your pipelines
- Prioritize optimization efforts
- Monitor bottleneck trends

**Ranking:**
- Sorted by total time spent (sum across all executions)
- Shows percentage of total execution time
- Includes execution count and average time

**Example:**
```bash
GET /v1/analytics/performance/engine/bottlenecks?hours=24&limit=10
```

### Example


```python
import mixpeek
from mixpeek.models.bottleneck_response import BottleneckResponse
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.AnalyticsApi(api_client)
    hours = 24 # int | Hours of history (optional) (default to 24)
    limit = 10 # int | Number of bottlenecks to return (optional) (default to 10)
    authorization = 'authorization_example' # str | REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. (optional)
    authorization2 = 'authorization_example' # str |  (optional)
    x_namespace = 'x_namespace_example' # str | REQUIRED: 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' (optional)

    try:
        # Analyze Bottlenecks
        api_response = api_instance.analyze_bottlenecks_analytics_performance_engine_0(hours=hours, limit=limit, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)
        print("The response of AnalyticsApi->analyze_bottlenecks_analytics_performance_engine_0:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AnalyticsApi->analyze_bottlenecks_analytics_performance_engine_0: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **hours** | **int**| Hours of history | [optional] [default to 24]
 **limit** | **int**| Number of bottlenecks to return | [optional] [default to 10]
 **authorization** | **str**| REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. | [optional] 
 **authorization2** | **str**|  | [optional] 
 **x_namespace** | **str**| REQUIRED: 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' | [optional] 

### Return type

[**BottleneckResponse**](BottleneckResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**400** | Bad Request |  -  |
**401** | Unauthorized |  -  |
**403** | Forbidden |  -  |
**404** | Not Found |  -  |
**422** | Validation Error |  -  |
**500** | Internal Server Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **analyze_for_tuning_analytics_retrievers**
> InteractionTuningResponse analyze_for_tuning_analytics_retrievers(retriever_id, days=days, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)

Analyze For Tuning

Analyze retriever and generate tuning recommendations.

Performs comprehensive analysis and generates actionable recommendations:
- Parameter tuning suggestions
- Cache optimization opportunities
- Performance improvement estimates

**Recommendations Include:**
- Increase/decrease k value
- Adjust reranking thresholds
- Enable/optimize caching
- Stage reordering suggestions

**Use Cases:**
- Initial retriever configuration
- Periodic performance optimization
- A/B testing parameter changes
- Cost optimization

**Example:**
```bash
curl -X POST "https://api.mixpeek.com/v1/analytics/retrievers/ret_abc123/analyze-tuning?days=7" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "X-Namespace: your-namespace"
```

### Example


```python
import mixpeek
from mixpeek.models.interaction_tuning_response import InteractionTuningResponse
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.AnalyticsApi(api_client)
    retriever_id = 'retriever_id_example' # str | 
    days = 7 # int | Days of history to analyze (optional) (default to 7)
    authorization = 'authorization_example' # str | REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. (optional)
    authorization2 = 'authorization_example' # str |  (optional)
    x_namespace = 'x_namespace_example' # str | REQUIRED: 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' (optional)

    try:
        # Analyze For Tuning
        api_response = api_instance.analyze_for_tuning_analytics_retrievers(retriever_id, days=days, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)
        print("The response of AnalyticsApi->analyze_for_tuning_analytics_retrievers:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AnalyticsApi->analyze_for_tuning_analytics_retrievers: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **retriever_id** | **str**|  | 
 **days** | **int**| Days of history to analyze | [optional] [default to 7]
 **authorization** | **str**| REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. | [optional] 
 **authorization2** | **str**|  | [optional] 
 **x_namespace** | **str**| REQUIRED: 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' | [optional] 

### Return type

[**InteractionTuningResponse**](InteractionTuningResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**400** | Bad Request |  -  |
**401** | Unauthorized |  -  |
**403** | Forbidden |  -  |
**404** | Not Found |  -  |
**422** | Validation Error |  -  |
**500** | Internal Server Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **analyze_for_tuning_analytics_retrievers_0**
> InteractionTuningResponse analyze_for_tuning_analytics_retrievers_0(retriever_id, days=days, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)

Analyze For Tuning

Analyze retriever and generate tuning recommendations.

Performs comprehensive analysis and generates actionable recommendations:
- Parameter tuning suggestions
- Cache optimization opportunities
- Performance improvement estimates

**Recommendations Include:**
- Increase/decrease k value
- Adjust reranking thresholds
- Enable/optimize caching
- Stage reordering suggestions

**Use Cases:**
- Initial retriever configuration
- Periodic performance optimization
- A/B testing parameter changes
- Cost optimization

**Example:**
```bash
curl -X POST "https://api.mixpeek.com/v1/analytics/retrievers/ret_abc123/analyze-tuning?days=7" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "X-Namespace: your-namespace"
```

### Example


```python
import mixpeek
from mixpeek.models.interaction_tuning_response import InteractionTuningResponse
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.AnalyticsApi(api_client)
    retriever_id = 'retriever_id_example' # str | 
    days = 7 # int | Days of history to analyze (optional) (default to 7)
    authorization = 'authorization_example' # str | REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. (optional)
    authorization2 = 'authorization_example' # str |  (optional)
    x_namespace = 'x_namespace_example' # str | REQUIRED: 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' (optional)

    try:
        # Analyze For Tuning
        api_response = api_instance.analyze_for_tuning_analytics_retrievers_0(retriever_id, days=days, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)
        print("The response of AnalyticsApi->analyze_for_tuning_analytics_retrievers_0:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AnalyticsApi->analyze_for_tuning_analytics_retrievers_0: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **retriever_id** | **str**|  | 
 **days** | **int**| Days of history to analyze | [optional] [default to 7]
 **authorization** | **str**| REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. | [optional] 
 **authorization2** | **str**|  | [optional] 
 **x_namespace** | **str**| REQUIRED: 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' | [optional] 

### Return type

[**InteractionTuningResponse**](InteractionTuningResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**400** | Bad Request |  -  |
**401** | Unauthorized |  -  |
**403** | Forbidden |  -  |
**404** | Not Found |  -  |
**422** | Validation Error |  -  |
**500** | Internal Server Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_assignment_metrics_analytics_taxonomies_taxonomy**
> AssignmentMetricsResponse get_assignment_metrics_analytics_taxonomies_taxonomy(taxonomy_id, start_date=start_date, end_date=end_date, group_by=group_by, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)

Get Assignment Metrics

Get taxonomy assignment metrics over time.

Tracks assignment counts including:
- Assignment volume over time
- Average confidence scores
- Unique labels assigned

**Use Cases:**
- Monitor taxonomy usage
- Track assignment trends
- Identify popular labels

### Example


```python
import mixpeek
from mixpeek.models.assignment_metrics_response import AssignmentMetricsResponse
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.AnalyticsApi(api_client)
    taxonomy_id = 'taxonomy_id_example' # str | 
    start_date = '2013-10-20T19:20:30+01:00' # datetime |  (optional)
    end_date = '2013-10-20T19:20:30+01:00' # datetime |  (optional)
    group_by = 'day' # str |  (optional) (default to 'day')
    authorization = 'authorization_example' # str | REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. (optional)
    authorization2 = 'authorization_example' # str |  (optional)
    x_namespace = 'x_namespace_example' # str | REQUIRED: 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' (optional)

    try:
        # Get Assignment Metrics
        api_response = api_instance.get_assignment_metrics_analytics_taxonomies_taxonomy(taxonomy_id, start_date=start_date, end_date=end_date, group_by=group_by, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)
        print("The response of AnalyticsApi->get_assignment_metrics_analytics_taxonomies_taxonomy:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AnalyticsApi->get_assignment_metrics_analytics_taxonomies_taxonomy: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **taxonomy_id** | **str**|  | 
 **start_date** | **datetime**|  | [optional] 
 **end_date** | **datetime**|  | [optional] 
 **group_by** | **str**|  | [optional] [default to 'day']
 **authorization** | **str**| REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. | [optional] 
 **authorization2** | **str**|  | [optional] 
 **x_namespace** | **str**| REQUIRED: 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' | [optional] 

### Return type

[**AssignmentMetricsResponse**](AssignmentMetricsResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**400** | Bad Request |  -  |
**401** | Unauthorized |  -  |
**403** | Forbidden |  -  |
**404** | Not Found |  -  |
**422** | Validation Error |  -  |
**500** | Internal Server Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_assignment_metrics_analytics_taxonomies_taxonomy_0**
> AssignmentMetricsResponse get_assignment_metrics_analytics_taxonomies_taxonomy_0(taxonomy_id, start_date=start_date, end_date=end_date, group_by=group_by, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)

Get Assignment Metrics

Get taxonomy assignment metrics over time.

Tracks assignment counts including:
- Assignment volume over time
- Average confidence scores
- Unique labels assigned

**Use Cases:**
- Monitor taxonomy usage
- Track assignment trends
- Identify popular labels

### Example


```python
import mixpeek
from mixpeek.models.assignment_metrics_response import AssignmentMetricsResponse
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.AnalyticsApi(api_client)
    taxonomy_id = 'taxonomy_id_example' # str | 
    start_date = '2013-10-20T19:20:30+01:00' # datetime |  (optional)
    end_date = '2013-10-20T19:20:30+01:00' # datetime |  (optional)
    group_by = 'day' # str |  (optional) (default to 'day')
    authorization = 'authorization_example' # str | REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. (optional)
    authorization2 = 'authorization_example' # str |  (optional)
    x_namespace = 'x_namespace_example' # str | REQUIRED: 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' (optional)

    try:
        # Get Assignment Metrics
        api_response = api_instance.get_assignment_metrics_analytics_taxonomies_taxonomy_0(taxonomy_id, start_date=start_date, end_date=end_date, group_by=group_by, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)
        print("The response of AnalyticsApi->get_assignment_metrics_analytics_taxonomies_taxonomy_0:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AnalyticsApi->get_assignment_metrics_analytics_taxonomies_taxonomy_0: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **taxonomy_id** | **str**|  | 
 **start_date** | **datetime**|  | [optional] 
 **end_date** | **datetime**|  | [optional] 
 **group_by** | **str**|  | [optional] [default to 'day']
 **authorization** | **str**| REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. | [optional] 
 **authorization2** | **str**|  | [optional] 
 **x_namespace** | **str**| REQUIRED: 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' | [optional] 

### Return type

[**AssignmentMetricsResponse**](AssignmentMetricsResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**400** | Bad Request |  -  |
**401** | Unauthorized |  -  |
**403** | Forbidden |  -  |
**404** | Not Found |  -  |
**422** | Validation Error |  -  |
**500** | Internal Server Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_batch_diagnostics_analytics_performance_batches**
> BatchDiagnostics get_batch_diagnostics_analytics_performance_batches(batch_id, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)

Get Batch Diagnostics

Get comprehensive diagnostics for a batch.

Combines batch status, task progress, collection info, performance metrics,
and actionable insights into a single response for easy frontend rendering.

**Use Cases:**
- Monitor batch processing in real-time
- Debug failed batches
- View performance breakdown after completion
- Get actionable next steps

**Response includes:**
- Overall batch status and progress
- Per-tier task details with Ray job links
- Collection document counts
- Performance insights and bottlenecks (if completed)
- Error details (if failed)
- Recommended next actions

**Example:**
```bash
GET /v1/analytics/performance/batches/{batch_id}/diagnostics
```

**Perfect for:**
- Real-time progress tracking UI
- Batch monitoring dashboards
- Debugging failed extractions
- Performance optimization

### Example


```python
import mixpeek
from mixpeek.models.batch_diagnostics import BatchDiagnostics
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.AnalyticsApi(api_client)
    batch_id = 'batch_id_example' # str | 
    authorization = 'authorization_example' # str | REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. (optional)
    authorization2 = 'authorization_example' # str |  (optional)
    x_namespace = 'x_namespace_example' # str | REQUIRED: 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' (optional)

    try:
        # Get Batch Diagnostics
        api_response = api_instance.get_batch_diagnostics_analytics_performance_batches(batch_id, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)
        print("The response of AnalyticsApi->get_batch_diagnostics_analytics_performance_batches:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AnalyticsApi->get_batch_diagnostics_analytics_performance_batches: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **batch_id** | **str**|  | 
 **authorization** | **str**| REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. | [optional] 
 **authorization2** | **str**|  | [optional] 
 **x_namespace** | **str**| REQUIRED: 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' | [optional] 

### Return type

[**BatchDiagnostics**](BatchDiagnostics.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**400** | Bad Request |  -  |
**401** | Unauthorized |  -  |
**403** | Forbidden |  -  |
**404** | Not Found |  -  |
**422** | Validation Error |  -  |
**500** | Internal Server Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_batch_diagnostics_analytics_performance_batches_0**
> BatchDiagnostics get_batch_diagnostics_analytics_performance_batches_0(batch_id, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)

Get Batch Diagnostics

Get comprehensive diagnostics for a batch.

Combines batch status, task progress, collection info, performance metrics,
and actionable insights into a single response for easy frontend rendering.

**Use Cases:**
- Monitor batch processing in real-time
- Debug failed batches
- View performance breakdown after completion
- Get actionable next steps

**Response includes:**
- Overall batch status and progress
- Per-tier task details with Ray job links
- Collection document counts
- Performance insights and bottlenecks (if completed)
- Error details (if failed)
- Recommended next actions

**Example:**
```bash
GET /v1/analytics/performance/batches/{batch_id}/diagnostics
```

**Perfect for:**
- Real-time progress tracking UI
- Batch monitoring dashboards
- Debugging failed extractions
- Performance optimization

### Example


```python
import mixpeek
from mixpeek.models.batch_diagnostics import BatchDiagnostics
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.AnalyticsApi(api_client)
    batch_id = 'batch_id_example' # str | 
    authorization = 'authorization_example' # str | REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. (optional)
    authorization2 = 'authorization_example' # str |  (optional)
    x_namespace = 'x_namespace_example' # str | REQUIRED: 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' (optional)

    try:
        # Get Batch Diagnostics
        api_response = api_instance.get_batch_diagnostics_analytics_performance_batches_0(batch_id, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)
        print("The response of AnalyticsApi->get_batch_diagnostics_analytics_performance_batches_0:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AnalyticsApi->get_batch_diagnostics_analytics_performance_batches_0: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **batch_id** | **str**|  | 
 **authorization** | **str**| REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. | [optional] 
 **authorization2** | **str**|  | [optional] 
 **x_namespace** | **str**| REQUIRED: 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' | [optional] 

### Return type

[**BatchDiagnostics**](BatchDiagnostics.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**400** | Bad Request |  -  |
**401** | Unauthorized |  -  |
**403** | Forbidden |  -  |
**404** | Not Found |  -  |
**422** | Validation Error |  -  |
**500** | Internal Server Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_bucket_health_analytics**
> BucketHealthResponse get_bucket_health_analytics(bucket_id, hours=hours, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)

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"
```

### Example


```python
import mixpeek
from mixpeek.models.bucket_health_response import BucketHealthResponse
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.AnalyticsApi(api_client)
    bucket_id = 'bucket_id_example' # str | 
    hours = 24 # int | Hours of history (optional) (default to 24)
    authorization = 'authorization_example' # str | REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. (optional)
    authorization2 = 'authorization_example' # str |  (optional)
    x_namespace = 'x_namespace_example' # str | REQUIRED: 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' (optional)

    try:
        # Get Bucket Health
        api_response = api_instance.get_bucket_health_analytics(bucket_id, hours=hours, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)
        print("The response of AnalyticsApi->get_bucket_health_analytics:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AnalyticsApi->get_bucket_health_analytics: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **bucket_id** | **str**|  | 
 **hours** | **int**| Hours of history | [optional] [default to 24]
 **authorization** | **str**| REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. | [optional] 
 **authorization2** | **str**|  | [optional] 
 **x_namespace** | **str**| REQUIRED: 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' | [optional] 

### Return type

[**BucketHealthResponse**](BucketHealthResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**400** | Bad Request |  -  |
**401** | Unauthorized |  -  |
**403** | Forbidden |  -  |
**404** | Not Found |  -  |
**422** | Validation Error |  -  |
**500** | Internal Server Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_bucket_health_analytics_0**
> BucketHealthResponse get_bucket_health_analytics_0(bucket_id, hours=hours, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)

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"
```

### Example


```python
import mixpeek
from mixpeek.models.bucket_health_response import BucketHealthResponse
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.AnalyticsApi(api_client)
    bucket_id = 'bucket_id_example' # str | 
    hours = 24 # int | Hours of history (optional) (default to 24)
    authorization = 'authorization_example' # str | REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. (optional)
    authorization2 = 'authorization_example' # str |  (optional)
    x_namespace = 'x_namespace_example' # str | REQUIRED: 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' (optional)

    try:
        # Get Bucket Health
        api_response = api_instance.get_bucket_health_analytics_0(bucket_id, hours=hours, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)
        print("The response of AnalyticsApi->get_bucket_health_analytics_0:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AnalyticsApi->get_bucket_health_analytics_0: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **bucket_id** | **str**|  | 
 **hours** | **int**| Hours of history | [optional] [default to 24]
 **authorization** | **str**| REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. | [optional] 
 **authorization2** | **str**|  | [optional] 
 **x_namespace** | **str**| REQUIRED: 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' | [optional] 

### Return type

[**BucketHealthResponse**](BucketHealthResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**400** | Bad Request |  -  |
**401** | Unauthorized |  -  |
**403** | Forbidden |  -  |
**404** | Not Found |  -  |
**422** | Validation Error |  -  |
**500** | Internal Server Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_bucket_storage_analytics**
> BucketStorageResponse get_bucket_storage_analytics(bucket_id, start_date=start_date, end_date=end_date, group_by=group_by, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)

Get Bucket Storage

Get storage growth trends over time.

Analyzes bucket storage metrics including:
- Total storage size over time
- Object count trends
- Growth rates

**Use Cases:**
- Monitor storage capacity planning
- Identify storage growth patterns
- Track object accumulation
- Alert on unexpected growth

**Example:**
```bash
curl -X GET "https://api.mixpeek.com/v1/analytics/buckets/bkt_abc123/storage?group_by=day" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "X-Namespace: your-namespace"
```

### Example


```python
import mixpeek
from mixpeek.models.bucket_storage_response import BucketStorageResponse
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.AnalyticsApi(api_client)
    bucket_id = 'bucket_id_example' # str | 
    start_date = '2013-10-20T19:20:30+01:00' # datetime | Start date (UTC) (optional)
    end_date = '2013-10-20T19:20:30+01:00' # datetime | End date (UTC) (optional)
    group_by = 'day' # str | Time grouping: hour, day, week, month (optional) (default to 'day')
    authorization = 'authorization_example' # str | REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. (optional)
    authorization2 = 'authorization_example' # str |  (optional)
    x_namespace = 'x_namespace_example' # str | REQUIRED: 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' (optional)

    try:
        # Get Bucket Storage
        api_response = api_instance.get_bucket_storage_analytics(bucket_id, start_date=start_date, end_date=end_date, group_by=group_by, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)
        print("The response of AnalyticsApi->get_bucket_storage_analytics:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AnalyticsApi->get_bucket_storage_analytics: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **bucket_id** | **str**|  | 
 **start_date** | **datetime**| Start date (UTC) | [optional] 
 **end_date** | **datetime**| End date (UTC) | [optional] 
 **group_by** | **str**| Time grouping: hour, day, week, month | [optional] [default to 'day']
 **authorization** | **str**| REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. | [optional] 
 **authorization2** | **str**|  | [optional] 
 **x_namespace** | **str**| REQUIRED: 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' | [optional] 

### Return type

[**BucketStorageResponse**](BucketStorageResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**400** | Bad Request |  -  |
**401** | Unauthorized |  -  |
**403** | Forbidden |  -  |
**404** | Not Found |  -  |
**422** | Validation Error |  -  |
**500** | Internal Server Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_bucket_storage_analytics_0**
> BucketStorageResponse get_bucket_storage_analytics_0(bucket_id, start_date=start_date, end_date=end_date, group_by=group_by, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)

Get Bucket Storage

Get storage growth trends over time.

Analyzes bucket storage metrics including:
- Total storage size over time
- Object count trends
- Growth rates

**Use Cases:**
- Monitor storage capacity planning
- Identify storage growth patterns
- Track object accumulation
- Alert on unexpected growth

**Example:**
```bash
curl -X GET "https://api.mixpeek.com/v1/analytics/buckets/bkt_abc123/storage?group_by=day" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "X-Namespace: your-namespace"
```

### Example


```python
import mixpeek
from mixpeek.models.bucket_storage_response import BucketStorageResponse
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.AnalyticsApi(api_client)
    bucket_id = 'bucket_id_example' # str | 
    start_date = '2013-10-20T19:20:30+01:00' # datetime | Start date (UTC) (optional)
    end_date = '2013-10-20T19:20:30+01:00' # datetime | End date (UTC) (optional)
    group_by = 'day' # str | Time grouping: hour, day, week, month (optional) (default to 'day')
    authorization = 'authorization_example' # str | REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. (optional)
    authorization2 = 'authorization_example' # str |  (optional)
    x_namespace = 'x_namespace_example' # str | REQUIRED: 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' (optional)

    try:
        # Get Bucket Storage
        api_response = api_instance.get_bucket_storage_analytics_0(bucket_id, start_date=start_date, end_date=end_date, group_by=group_by, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)
        print("The response of AnalyticsApi->get_bucket_storage_analytics_0:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AnalyticsApi->get_bucket_storage_analytics_0: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **bucket_id** | **str**|  | 
 **start_date** | **datetime**| Start date (UTC) | [optional] 
 **end_date** | **datetime**| End date (UTC) | [optional] 
 **group_by** | **str**| Time grouping: hour, day, week, month | [optional] [default to 'day']
 **authorization** | **str**| REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. | [optional] 
 **authorization2** | **str**|  | [optional] 
 **x_namespace** | **str**| REQUIRED: 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' | [optional] 

### Return type

[**BucketStorageResponse**](BucketStorageResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**400** | Bad Request |  -  |
**401** | Unauthorized |  -  |
**403** | Forbidden |  -  |
**404** | Not Found |  -  |
**422** | Validation Error |  -  |
**500** | Internal Server Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_bucket_usage_analytics**
> BucketUsageResponse get_bucket_usage_analytics(bucket_id, start_date=start_date, end_date=end_date, group_by=group_by, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)

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"
```

### Example


```python
import mixpeek
from mixpeek.models.bucket_usage_response import BucketUsageResponse
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.AnalyticsApi(api_client)
    bucket_id = 'bucket_id_example' # str | 
    start_date = '2013-10-20T19:20:30+01:00' # datetime | Start date (UTC) (optional)
    end_date = '2013-10-20T19:20:30+01:00' # datetime | End date (UTC) (optional)
    group_by = 'day' # str | Time grouping: hour, day, week, month (optional) (default to 'day')
    authorization = 'authorization_example' # str | REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. (optional)
    authorization2 = 'authorization_example' # str |  (optional)
    x_namespace = 'x_namespace_example' # str | REQUIRED: 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' (optional)

    try:
        # Get Bucket Usage
        api_response = api_instance.get_bucket_usage_analytics(bucket_id, start_date=start_date, end_date=end_date, group_by=group_by, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)
        print("The response of AnalyticsApi->get_bucket_usage_analytics:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AnalyticsApi->get_bucket_usage_analytics: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **bucket_id** | **str**|  | 
 **start_date** | **datetime**| Start date (UTC) | [optional] 
 **end_date** | **datetime**| End date (UTC) | [optional] 
 **group_by** | **str**| Time grouping: hour, day, week, month | [optional] [default to 'day']
 **authorization** | **str**| REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. | [optional] 
 **authorization2** | **str**|  | [optional] 
 **x_namespace** | **str**| REQUIRED: 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' | [optional] 

### Return type

[**BucketUsageResponse**](BucketUsageResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**400** | Bad Request |  -  |
**401** | Unauthorized |  -  |
**403** | Forbidden |  -  |
**404** | Not Found |  -  |
**422** | Validation Error |  -  |
**500** | Internal Server Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_bucket_usage_analytics_0**
> BucketUsageResponse get_bucket_usage_analytics_0(bucket_id, start_date=start_date, end_date=end_date, group_by=group_by, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)

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"
```

### Example


```python
import mixpeek
from mixpeek.models.bucket_usage_response import BucketUsageResponse
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.AnalyticsApi(api_client)
    bucket_id = 'bucket_id_example' # str | 
    start_date = '2013-10-20T19:20:30+01:00' # datetime | Start date (UTC) (optional)
    end_date = '2013-10-20T19:20:30+01:00' # datetime | End date (UTC) (optional)
    group_by = 'day' # str | Time grouping: hour, day, week, month (optional) (default to 'day')
    authorization = 'authorization_example' # str | REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. (optional)
    authorization2 = 'authorization_example' # str |  (optional)
    x_namespace = 'x_namespace_example' # str | REQUIRED: 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' (optional)

    try:
        # Get Bucket Usage
        api_response = api_instance.get_bucket_usage_analytics_0(bucket_id, start_date=start_date, end_date=end_date, group_by=group_by, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)
        print("The response of AnalyticsApi->get_bucket_usage_analytics_0:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AnalyticsApi->get_bucket_usage_analytics_0: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **bucket_id** | **str**|  | 
 **start_date** | **datetime**| Start date (UTC) | [optional] 
 **end_date** | **datetime**| End date (UTC) | [optional] 
 **group_by** | **str**| Time grouping: hour, day, week, month | [optional] [default to 'day']
 **authorization** | **str**| REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. | [optional] 
 **authorization2** | **str**|  | [optional] 
 **x_namespace** | **str**| REQUIRED: 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' | [optional] 

### Return type

[**BucketUsageResponse**](BucketUsageResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**400** | Bad Request |  -  |
**401** | Unauthorized |  -  |
**403** | Forbidden |  -  |
**404** | Not Found |  -  |
**422** | Validation Error |  -  |
**500** | Internal Server Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_cache_performance_analytics_retrievers**
> CachePerformanceResponse get_cache_performance_analytics_retrievers(retriever_id, hours=hours, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)

Get Cache Performance

Get cache performance metrics.

Analyzes cache effectiveness including:
- Hit/miss rates
- Latency comparison (cache vs full search)
- Hourly cache performance trends

**Use Cases:**
- Evaluate cache effectiveness
- Optimize cache TTL settings
- Monitor cache performance
- Identify cache warming opportunities

**Example:**
```bash
curl -X GET "https://api.mixpeek.com/v1/analytics/retrievers/ret_abc123/cache-performance?hours=168" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "X-Namespace: your-namespace"
```

### Example


```python
import mixpeek
from mixpeek.models.cache_performance_response import CachePerformanceResponse
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.AnalyticsApi(api_client)
    retriever_id = 'retriever_id_example' # str | 
    hours = 24 # int | Hours of history (optional) (default to 24)
    authorization = 'authorization_example' # str | REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. (optional)
    authorization2 = 'authorization_example' # str |  (optional)
    x_namespace = 'x_namespace_example' # str | REQUIRED: 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' (optional)

    try:
        # Get Cache Performance
        api_response = api_instance.get_cache_performance_analytics_retrievers(retriever_id, hours=hours, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)
        print("The response of AnalyticsApi->get_cache_performance_analytics_retrievers:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AnalyticsApi->get_cache_performance_analytics_retrievers: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **retriever_id** | **str**|  | 
 **hours** | **int**| Hours of history | [optional] [default to 24]
 **authorization** | **str**| REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. | [optional] 
 **authorization2** | **str**|  | [optional] 
 **x_namespace** | **str**| REQUIRED: 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' | [optional] 

### Return type

[**CachePerformanceResponse**](CachePerformanceResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**400** | Bad Request |  -  |
**401** | Unauthorized |  -  |
**403** | Forbidden |  -  |
**404** | Not Found |  -  |
**422** | Validation Error |  -  |
**500** | Internal Server Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_cache_performance_analytics_retrievers_0**
> CachePerformanceResponse get_cache_performance_analytics_retrievers_0(retriever_id, hours=hours, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)

Get Cache Performance

Get cache performance metrics.

Analyzes cache effectiveness including:
- Hit/miss rates
- Latency comparison (cache vs full search)
- Hourly cache performance trends

**Use Cases:**
- Evaluate cache effectiveness
- Optimize cache TTL settings
- Monitor cache performance
- Identify cache warming opportunities

**Example:**
```bash
curl -X GET "https://api.mixpeek.com/v1/analytics/retrievers/ret_abc123/cache-performance?hours=168" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "X-Namespace: your-namespace"
```

### Example


```python
import mixpeek
from mixpeek.models.cache_performance_response import CachePerformanceResponse
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.AnalyticsApi(api_client)
    retriever_id = 'retriever_id_example' # str | 
    hours = 24 # int | Hours of history (optional) (default to 24)
    authorization = 'authorization_example' # str | REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. (optional)
    authorization2 = 'authorization_example' # str |  (optional)
    x_namespace = 'x_namespace_example' # str | REQUIRED: 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' (optional)

    try:
        # Get Cache Performance
        api_response = api_instance.get_cache_performance_analytics_retrievers_0(retriever_id, hours=hours, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)
        print("The response of AnalyticsApi->get_cache_performance_analytics_retrievers_0:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AnalyticsApi->get_cache_performance_analytics_retrievers_0: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **retriever_id** | **str**|  | 
 **hours** | **int**| Hours of history | [optional] [default to 24]
 **authorization** | **str**| REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. | [optional] 
 **authorization2** | **str**|  | [optional] 
 **x_namespace** | **str**| REQUIRED: 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' | [optional] 

### Return type

[**CachePerformanceResponse**](CachePerformanceResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**400** | Bad Request |  -  |
**401** | Unauthorized |  -  |
**403** | Forbidden |  -  |
**404** | Not Found |  -  |
**422** | Validation Error |  -  |
**500** | Internal Server Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_collection_overview_analytics**
> CollectionOverviewResponse get_collection_overview_analytics(collection_id, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)

Get Collection Overview

Get high-level collection health and status metrics.

Provides collection health including:
- Total document count and recent growth
- Processing performance and success rates
- Active enrichments (taxonomies, clusters)

**Use Cases:**
- Monitor collection health
- Quick status check
- Identify collections needing attention

### Example


```python
import mixpeek
from mixpeek.models.collection_overview_response import CollectionOverviewResponse
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.AnalyticsApi(api_client)
    collection_id = 'collection_id_example' # str | 
    authorization = 'authorization_example' # str | REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. (optional)
    authorization2 = 'authorization_example' # str |  (optional)
    x_namespace = 'x_namespace_example' # str | REQUIRED: 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' (optional)

    try:
        # Get Collection Overview
        api_response = api_instance.get_collection_overview_analytics(collection_id, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)
        print("The response of AnalyticsApi->get_collection_overview_analytics:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AnalyticsApi->get_collection_overview_analytics: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **collection_id** | **str**|  | 
 **authorization** | **str**| REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. | [optional] 
 **authorization2** | **str**|  | [optional] 
 **x_namespace** | **str**| REQUIRED: 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' | [optional] 

### Return type

[**CollectionOverviewResponse**](CollectionOverviewResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**400** | Bad Request |  -  |
**401** | Unauthorized |  -  |
**403** | Forbidden |  -  |
**404** | Not Found |  -  |
**422** | Validation Error |  -  |
**500** | Internal Server Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_collection_overview_analytics_0**
> CollectionOverviewResponse get_collection_overview_analytics_0(collection_id, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)

Get Collection Overview

Get high-level collection health and status metrics.

Provides collection health including:
- Total document count and recent growth
- Processing performance and success rates
- Active enrichments (taxonomies, clusters)

**Use Cases:**
- Monitor collection health
- Quick status check
- Identify collections needing attention

### Example


```python
import mixpeek
from mixpeek.models.collection_overview_response import CollectionOverviewResponse
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.AnalyticsApi(api_client)
    collection_id = 'collection_id_example' # str | 
    authorization = 'authorization_example' # str | REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. (optional)
    authorization2 = 'authorization_example' # str |  (optional)
    x_namespace = 'x_namespace_example' # str | REQUIRED: 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' (optional)

    try:
        # Get Collection Overview
        api_response = api_instance.get_collection_overview_analytics_0(collection_id, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)
        print("The response of AnalyticsApi->get_collection_overview_analytics_0:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AnalyticsApi->get_collection_overview_analytics_0: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **collection_id** | **str**|  | 
 **authorization** | **str**| REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. | [optional] 
 **authorization2** | **str**|  | [optional] 
 **x_namespace** | **str**| REQUIRED: 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' | [optional] 

### Return type

[**CollectionOverviewResponse**](CollectionOverviewResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**400** | Bad Request |  -  |
**401** | Unauthorized |  -  |
**403** | Forbidden |  -  |
**404** | Not Found |  -  |
**422** | Validation Error |  -  |
**500** | Internal Server Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_compound_index_patterns_analytics_namespaces_indexes**
> CompoundIndexResponse get_compound_index_patterns_analytics_namespaces_indexes(days=days, limit=limit, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)

Get Compound Index Patterns

Identify compound index opportunities.

Finds metadata fields commonly used together in filters, suggesting
opportunities for compound (multi-field) indexes.

**Use Cases:**
- Optimize multi-field queries
- Create compound indexes
- Understand query complexity
- Improve complex filter performance

**Response Includes:**
- Field combinations used together
- Frequency of combination usage
- Average and P95 latency
- Sorted by combination frequency

**Compound Index Example:**
If `brand + status` appears frequently, create:
```javascript
db.documents.createIndex({"metadata.brand": 1, "metadata.status": 1})
```

**Example:**
```bash
curl -X GET "https://api.mixpeek.com/v1/analytics/namespaces/indexes/compound-patterns" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "X-Namespace: your-namespace"
```

### Example


```python
import mixpeek
from mixpeek.models.compound_index_response import CompoundIndexResponse
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.AnalyticsApi(api_client)
    days = 30 # int | Days of history to analyze (optional) (default to 30)
    limit = 50 # int | Maximum patterns to return (optional) (default to 50)
    authorization = 'authorization_example' # str | REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. (optional)
    authorization2 = 'authorization_example' # str |  (optional)
    x_namespace = 'x_namespace_example' # str | REQUIRED: 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' (optional)

    try:
        # Get Compound Index Patterns
        api_response = api_instance.get_compound_index_patterns_analytics_namespaces_indexes(days=days, limit=limit, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)
        print("The response of AnalyticsApi->get_compound_index_patterns_analytics_namespaces_indexes:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AnalyticsApi->get_compound_index_patterns_analytics_namespaces_indexes: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **days** | **int**| Days of history to analyze | [optional] [default to 30]
 **limit** | **int**| Maximum patterns to return | [optional] [default to 50]
 **authorization** | **str**| REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. | [optional] 
 **authorization2** | **str**|  | [optional] 
 **x_namespace** | **str**| REQUIRED: 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' | [optional] 

### Return type

[**CompoundIndexResponse**](CompoundIndexResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**400** | Bad Request |  -  |
**401** | Unauthorized |  -  |
**403** | Forbidden |  -  |
**404** | Not Found |  -  |
**422** | Validation Error |  -  |
**500** | Internal Server Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_compound_index_patterns_analytics_namespaces_indexes_0**
> CompoundIndexResponse get_compound_index_patterns_analytics_namespaces_indexes_0(days=days, limit=limit, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)

Get Compound Index Patterns

Identify compound index opportunities.

Finds metadata fields commonly used together in filters, suggesting
opportunities for compound (multi-field) indexes.

**Use Cases:**
- Optimize multi-field queries
- Create compound indexes
- Understand query complexity
- Improve complex filter performance

**Response Includes:**
- Field combinations used together
- Frequency of combination usage
- Average and P95 latency
- Sorted by combination frequency

**Compound Index Example:**
If `brand + status` appears frequently, create:
```javascript
db.documents.createIndex({"metadata.brand": 1, "metadata.status": 1})
```

**Example:**
```bash
curl -X GET "https://api.mixpeek.com/v1/analytics/namespaces/indexes/compound-patterns" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "X-Namespace: your-namespace"
```

### Example


```python
import mixpeek
from mixpeek.models.compound_index_response import CompoundIndexResponse
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.AnalyticsApi(api_client)
    days = 30 # int | Days of history to analyze (optional) (default to 30)
    limit = 50 # int | Maximum patterns to return (optional) (default to 50)
    authorization = 'authorization_example' # str | REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. (optional)
    authorization2 = 'authorization_example' # str |  (optional)
    x_namespace = 'x_namespace_example' # str | REQUIRED: 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' (optional)

    try:
        # Get Compound Index Patterns
        api_response = api_instance.get_compound_index_patterns_analytics_namespaces_indexes_0(days=days, limit=limit, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)
        print("The response of AnalyticsApi->get_compound_index_patterns_analytics_namespaces_indexes_0:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AnalyticsApi->get_compound_index_patterns_analytics_namespaces_indexes_0: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **days** | **int**| Days of history to analyze | [optional] [default to 30]
 **limit** | **int**| Maximum patterns to return | [optional] [default to 50]
 **authorization** | **str**| REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. | [optional] 
 **authorization2** | **str**|  | [optional] 
 **x_namespace** | **str**| REQUIRED: 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' | [optional] 

### Return type

[**CompoundIndexResponse**](CompoundIndexResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**400** | Bad Request |  -  |
**401** | Unauthorized |  -  |
**403** | Forbidden |  -  |
**404** | Not Found |  -  |
**422** | Validation Error |  -  |
**500** | Internal Server Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_confidence_distribution_analytics_taxonomies_taxonomy**
> ConfidenceResponse get_confidence_distribution_analytics_taxonomies_taxonomy(taxonomy_id, hours=hours, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)

Get Confidence Distribution

Get confidence score distribution.

Analyzes assignment confidence including:
- Distribution across confidence ranges
- Low-confidence assignment alerts
- Average confidence trends

**Use Cases:**
- Monitor taxonomy quality
- Identify low-confidence assignments
- Track confidence improvements

### Example


```python
import mixpeek
from mixpeek.models.confidence_response import ConfidenceResponse
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.AnalyticsApi(api_client)
    taxonomy_id = 'taxonomy_id_example' # str | 
    hours = 168 # int |  (optional) (default to 168)
    authorization = 'authorization_example' # str | REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. (optional)
    authorization2 = 'authorization_example' # str |  (optional)
    x_namespace = 'x_namespace_example' # str | REQUIRED: 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' (optional)

    try:
        # Get Confidence Distribution
        api_response = api_instance.get_confidence_distribution_analytics_taxonomies_taxonomy(taxonomy_id, hours=hours, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)
        print("The response of AnalyticsApi->get_confidence_distribution_analytics_taxonomies_taxonomy:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AnalyticsApi->get_confidence_distribution_analytics_taxonomies_taxonomy: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **taxonomy_id** | **str**|  | 
 **hours** | **int**|  | [optional] [default to 168]
 **authorization** | **str**| REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. | [optional] 
 **authorization2** | **str**|  | [optional] 
 **x_namespace** | **str**| REQUIRED: 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' | [optional] 

### Return type

[**ConfidenceResponse**](ConfidenceResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**400** | Bad Request |  -  |
**401** | Unauthorized |  -  |
**403** | Forbidden |  -  |
**404** | Not Found |  -  |
**422** | Validation Error |  -  |
**500** | Internal Server Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_confidence_distribution_analytics_taxonomies_taxonomy_0**
> ConfidenceResponse get_confidence_distribution_analytics_taxonomies_taxonomy_0(taxonomy_id, hours=hours, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)

Get Confidence Distribution

Get confidence score distribution.

Analyzes assignment confidence including:
- Distribution across confidence ranges
- Low-confidence assignment alerts
- Average confidence trends

**Use Cases:**
- Monitor taxonomy quality
- Identify low-confidence assignments
- Track confidence improvements

### Example


```python
import mixpeek
from mixpeek.models.confidence_response import ConfidenceResponse
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.AnalyticsApi(api_client)
    taxonomy_id = 'taxonomy_id_example' # str | 
    hours = 168 # int |  (optional) (default to 168)
    authorization = 'authorization_example' # str | REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. (optional)
    authorization2 = 'authorization_example' # str |  (optional)
    x_namespace = 'x_namespace_example' # str | REQUIRED: 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' (optional)

    try:
        # Get Confidence Distribution
        api_response = api_instance.get_confidence_distribution_analytics_taxonomies_taxonomy_0(taxonomy_id, hours=hours, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)
        print("The response of AnalyticsApi->get_confidence_distribution_analytics_taxonomies_taxonomy_0:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AnalyticsApi->get_confidence_distribution_analytics_taxonomies_taxonomy_0: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **taxonomy_id** | **str**|  | 
 **hours** | **int**|  | [optional] [default to 168]
 **authorization** | **str**| REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. | [optional] 
 **authorization2** | **str**|  | [optional] 
 **x_namespace** | **str**| REQUIRED: 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' | [optional] 

### Return type

[**ConfidenceResponse**](ConfidenceResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**400** | Bad Request |  -  |
**401** | Unauthorized |  -  |
**403** | Forbidden |  -  |
**404** | Not Found |  -  |
**422** | Validation Error |  -  |
**500** | Internal Server Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_document_growth_analytics**
> GrowthMetricsResponse get_document_growth_analytics(collection_id, start_date=start_date, end_date=end_date, group_by=group_by, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)

Get Document Growth

Get document growth trends over time.

Tracks document additions over time, useful for understanding
batch processing patterns and indexing velocity.

### Example


```python
import mixpeek
from mixpeek.models.growth_metrics_response import GrowthMetricsResponse
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.AnalyticsApi(api_client)
    collection_id = 'collection_id_example' # str | 
    start_date = '2013-10-20T19:20:30+01:00' # datetime |  (optional)
    end_date = '2013-10-20T19:20:30+01:00' # datetime |  (optional)
    group_by = 'day' # str | hour, day, week, month (optional) (default to 'day')
    authorization = 'authorization_example' # str | REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. (optional)
    authorization2 = 'authorization_example' # str |  (optional)
    x_namespace = 'x_namespace_example' # str | REQUIRED: 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' (optional)

    try:
        # Get Document Growth
        api_response = api_instance.get_document_growth_analytics(collection_id, start_date=start_date, end_date=end_date, group_by=group_by, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)
        print("The response of AnalyticsApi->get_document_growth_analytics:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AnalyticsApi->get_document_growth_analytics: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **collection_id** | **str**|  | 
 **start_date** | **datetime**|  | [optional] 
 **end_date** | **datetime**|  | [optional] 
 **group_by** | **str**| hour, day, week, month | [optional] [default to 'day']
 **authorization** | **str**| REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. | [optional] 
 **authorization2** | **str**|  | [optional] 
 **x_namespace** | **str**| REQUIRED: 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' | [optional] 

### Return type

[**GrowthMetricsResponse**](GrowthMetricsResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**400** | Bad Request |  -  |
**401** | Unauthorized |  -  |
**403** | Forbidden |  -  |
**404** | Not Found |  -  |
**422** | Validation Error |  -  |
**500** | Internal Server Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_document_growth_analytics_0**
> GrowthMetricsResponse get_document_growth_analytics_0(collection_id, start_date=start_date, end_date=end_date, group_by=group_by, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)

Get Document Growth

Get document growth trends over time.

Tracks document additions over time, useful for understanding
batch processing patterns and indexing velocity.

### Example


```python
import mixpeek
from mixpeek.models.growth_metrics_response import GrowthMetricsResponse
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.AnalyticsApi(api_client)
    collection_id = 'collection_id_example' # str | 
    start_date = '2013-10-20T19:20:30+01:00' # datetime |  (optional)
    end_date = '2013-10-20T19:20:30+01:00' # datetime |  (optional)
    group_by = 'day' # str | hour, day, week, month (optional) (default to 'day')
    authorization = 'authorization_example' # str | REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. (optional)
    authorization2 = 'authorization_example' # str |  (optional)
    x_namespace = 'x_namespace_example' # str | REQUIRED: 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' (optional)

    try:
        # Get Document Growth
        api_response = api_instance.get_document_growth_analytics_0(collection_id, start_date=start_date, end_date=end_date, group_by=group_by, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)
        print("The response of AnalyticsApi->get_document_growth_analytics_0:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AnalyticsApi->get_document_growth_analytics_0: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **collection_id** | **str**|  | 
 **start_date** | **datetime**|  | [optional] 
 **end_date** | **datetime**|  | [optional] 
 **group_by** | **str**| hour, day, week, month | [optional] [default to 'day']
 **authorization** | **str**| REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. | [optional] 
 **authorization2** | **str**|  | [optional] 
 **x_namespace** | **str**| REQUIRED: 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' | [optional] 

### Return type

[**GrowthMetricsResponse**](GrowthMetricsResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**400** | Bad Request |  -  |
**401** | Unauthorized |  -  |
**403** | Forbidden |  -  |
**404** | Not Found |  -  |
**422** | Validation Error |  -  |
**500** | Internal Server Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_engine_performance_analytics**
> EnginePerformanceResponse get_engine_performance_analytics(hours=hours, start_date=start_date, end_date=end_date, group_by=group_by, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)

Get Engine Performance

Get engine performance metrics over time.

Query profiling data logged by the engine's profiling infrastructure.
All queries are automatically filtered to your namespace.

**Time Range:**
- Specify `hours` for recent history (e.g., `hours=24` for last 24 hours)
- OR specify `start_date` and `end_date` for custom range
- Defaults to last 24 hours if neither provided

**Grouping:**
- `minute`: High-resolution (for short time ranges)
- `hour`: Standard resolution (default)
- `day`: For longer time ranges
- `week`, `month`: For historical trends

**Response:**
- Time-series metrics (avg, p50, p95, p99 latencies)
- Summary statistics across the entire time range
- All latencies in milliseconds

**Example:**
```bash
GET /v1/analytics/performance/engine?hours=24&group_by=hour
```

### Example


```python
import mixpeek
from mixpeek.models.engine_performance_response import EnginePerformanceResponse
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.AnalyticsApi(api_client)
    hours = 56 # int | Hours of history (alternative to date range) (optional)
    start_date = '2013-10-20T19:20:30+01:00' # datetime | Start date for time range (optional)
    end_date = '2013-10-20T19:20:30+01:00' # datetime | End date for time range (optional)
    group_by = 'hour' # str | Time grouping (minute, hour, day, week) (optional) (default to 'hour')
    authorization = 'authorization_example' # str | REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. (optional)
    authorization2 = 'authorization_example' # str |  (optional)
    x_namespace = 'x_namespace_example' # str | REQUIRED: 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' (optional)

    try:
        # Get Engine Performance
        api_response = api_instance.get_engine_performance_analytics(hours=hours, start_date=start_date, end_date=end_date, group_by=group_by, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)
        print("The response of AnalyticsApi->get_engine_performance_analytics:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AnalyticsApi->get_engine_performance_analytics: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **hours** | **int**| Hours of history (alternative to date range) | [optional] 
 **start_date** | **datetime**| Start date for time range | [optional] 
 **end_date** | **datetime**| End date for time range | [optional] 
 **group_by** | **str**| Time grouping (minute, hour, day, week) | [optional] [default to 'hour']
 **authorization** | **str**| REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. | [optional] 
 **authorization2** | **str**|  | [optional] 
 **x_namespace** | **str**| REQUIRED: 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' | [optional] 

### Return type

[**EnginePerformanceResponse**](EnginePerformanceResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**400** | Bad Request |  -  |
**401** | Unauthorized |  -  |
**403** | Forbidden |  -  |
**404** | Not Found |  -  |
**422** | Validation Error |  -  |
**500** | Internal Server Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_engine_performance_analytics_0**
> EnginePerformanceResponse get_engine_performance_analytics_0(hours=hours, start_date=start_date, end_date=end_date, group_by=group_by, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)

Get Engine Performance

Get engine performance metrics over time.

Query profiling data logged by the engine's profiling infrastructure.
All queries are automatically filtered to your namespace.

**Time Range:**
- Specify `hours` for recent history (e.g., `hours=24` for last 24 hours)
- OR specify `start_date` and `end_date` for custom range
- Defaults to last 24 hours if neither provided

**Grouping:**
- `minute`: High-resolution (for short time ranges)
- `hour`: Standard resolution (default)
- `day`: For longer time ranges
- `week`, `month`: For historical trends

**Response:**
- Time-series metrics (avg, p50, p95, p99 latencies)
- Summary statistics across the entire time range
- All latencies in milliseconds

**Example:**
```bash
GET /v1/analytics/performance/engine?hours=24&group_by=hour
```

### Example


```python
import mixpeek
from mixpeek.models.engine_performance_response import EnginePerformanceResponse
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.AnalyticsApi(api_client)
    hours = 56 # int | Hours of history (alternative to date range) (optional)
    start_date = '2013-10-20T19:20:30+01:00' # datetime | Start date for time range (optional)
    end_date = '2013-10-20T19:20:30+01:00' # datetime | End date for time range (optional)
    group_by = 'hour' # str | Time grouping (minute, hour, day, week) (optional) (default to 'hour')
    authorization = 'authorization_example' # str | REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. (optional)
    authorization2 = 'authorization_example' # str |  (optional)
    x_namespace = 'x_namespace_example' # str | REQUIRED: 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' (optional)

    try:
        # Get Engine Performance
        api_response = api_instance.get_engine_performance_analytics_0(hours=hours, start_date=start_date, end_date=end_date, group_by=group_by, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)
        print("The response of AnalyticsApi->get_engine_performance_analytics_0:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AnalyticsApi->get_engine_performance_analytics_0: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **hours** | **int**| Hours of history (alternative to date range) | [optional] 
 **start_date** | **datetime**| Start date for time range | [optional] 
 **end_date** | **datetime**| End date for time range | [optional] 
 **group_by** | **str**| Time grouping (minute, hour, day, week) | [optional] [default to 'hour']
 **authorization** | **str**| REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. | [optional] 
 **authorization2** | **str**|  | [optional] 
 **x_namespace** | **str**| REQUIRED: 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' | [optional] 

### Return type

[**EnginePerformanceResponse**](EnginePerformanceResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**400** | Bad Request |  -  |
**401** | Unauthorized |  -  |
**403** | Forbidden |  -  |
**404** | Not Found |  -  |
**422** | Validation Error |  -  |
**500** | Internal Server Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_engine_stage_breakdown_analytics_performance**
> EngineStageBreakdownResponse get_engine_stage_breakdown_analytics_performance(hours=hours, start_date=start_date, end_date=end_date, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)

Get Engine Stage Breakdown

Get stage-level performance breakdown.

Breaks down engine performance by individual profiled stages
(e.g., pipeline_run, generate_input_dataset, gcs_batch_upload).

**Use Cases:**
- Identify which stages are slowest
- See percentage of total time per stage
- Optimize specific bottlenecks

**Response:**
- Per-stage metrics (count, avg, p95, max latencies)
- Total time spent in each stage
- Percentage of total execution time
- Sorted by total time (worst bottlenecks first)

**Example:**
```bash
GET /v1/analytics/performance/engine/stages?hours=24
```

### Example


```python
import mixpeek
from mixpeek.models.engine_stage_breakdown_response import EngineStageBreakdownResponse
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.AnalyticsApi(api_client)
    hours = 56 # int | Hours of history (optional)
    start_date = '2013-10-20T19:20:30+01:00' # datetime | Start date (optional)
    end_date = '2013-10-20T19:20:30+01:00' # datetime | End date (optional)
    authorization = 'authorization_example' # str | REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. (optional)
    authorization2 = 'authorization_example' # str |  (optional)
    x_namespace = 'x_namespace_example' # str | REQUIRED: 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' (optional)

    try:
        # Get Engine Stage Breakdown
        api_response = api_instance.get_engine_stage_breakdown_analytics_performance(hours=hours, start_date=start_date, end_date=end_date, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)
        print("The response of AnalyticsApi->get_engine_stage_breakdown_analytics_performance:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AnalyticsApi->get_engine_stage_breakdown_analytics_performance: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **hours** | **int**| Hours of history | [optional] 
 **start_date** | **datetime**| Start date | [optional] 
 **end_date** | **datetime**| End date | [optional] 
 **authorization** | **str**| REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. | [optional] 
 **authorization2** | **str**|  | [optional] 
 **x_namespace** | **str**| REQUIRED: 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' | [optional] 

### Return type

[**EngineStageBreakdownResponse**](EngineStageBreakdownResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**400** | Bad Request |  -  |
**401** | Unauthorized |  -  |
**403** | Forbidden |  -  |
**404** | Not Found |  -  |
**422** | Validation Error |  -  |
**500** | Internal Server Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_engine_stage_breakdown_analytics_performance_0**
> EngineStageBreakdownResponse get_engine_stage_breakdown_analytics_performance_0(hours=hours, start_date=start_date, end_date=end_date, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)

Get Engine Stage Breakdown

Get stage-level performance breakdown.

Breaks down engine performance by individual profiled stages
(e.g., pipeline_run, generate_input_dataset, gcs_batch_upload).

**Use Cases:**
- Identify which stages are slowest
- See percentage of total time per stage
- Optimize specific bottlenecks

**Response:**
- Per-stage metrics (count, avg, p95, max latencies)
- Total time spent in each stage
- Percentage of total execution time
- Sorted by total time (worst bottlenecks first)

**Example:**
```bash
GET /v1/analytics/performance/engine/stages?hours=24
```

### Example


```python
import mixpeek
from mixpeek.models.engine_stage_breakdown_response import EngineStageBreakdownResponse
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.AnalyticsApi(api_client)
    hours = 56 # int | Hours of history (optional)
    start_date = '2013-10-20T19:20:30+01:00' # datetime | Start date (optional)
    end_date = '2013-10-20T19:20:30+01:00' # datetime | End date (optional)
    authorization = 'authorization_example' # str | REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. (optional)
    authorization2 = 'authorization_example' # str |  (optional)
    x_namespace = 'x_namespace_example' # str | REQUIRED: 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' (optional)

    try:
        # Get Engine Stage Breakdown
        api_response = api_instance.get_engine_stage_breakdown_analytics_performance_0(hours=hours, start_date=start_date, end_date=end_date, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)
        print("The response of AnalyticsApi->get_engine_stage_breakdown_analytics_performance_0:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AnalyticsApi->get_engine_stage_breakdown_analytics_performance_0: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **hours** | **int**| Hours of history | [optional] 
 **start_date** | **datetime**| Start date | [optional] 
 **end_date** | **datetime**| End date | [optional] 
 **authorization** | **str**| REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. | [optional] 
 **authorization2** | **str**|  | [optional] 
 **x_namespace** | **str**| REQUIRED: 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' | [optional] 

### Return type

[**EngineStageBreakdownResponse**](EngineStageBreakdownResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**400** | Bad Request |  -  |
**401** | Unauthorized |  -  |
**403** | Forbidden |  -  |
**404** | Not Found |  -  |
**422** | Validation Error |  -  |
**500** | Internal Server Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_enrichment_history_analytics_taxonomies_taxonomy**
> EnrichmentHistoryResponse get_enrichment_history_analytics_taxonomies_taxonomy(taxonomy_id, start_date=start_date, end_date=end_date, group_by=group_by, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)

Get Enrichment History

Get enrichment execution history.

Tracks enrichment operations including:
- Enrichment success rates
- Average latency
- Volume trends

**Use Cases:**
- Monitor enrichment performance
- Track success rates
- Identify performance issues

### Example


```python
import mixpeek
from mixpeek.models.enrichment_history_response import EnrichmentHistoryResponse
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.AnalyticsApi(api_client)
    taxonomy_id = 'taxonomy_id_example' # str | 
    start_date = '2013-10-20T19:20:30+01:00' # datetime |  (optional)
    end_date = '2013-10-20T19:20:30+01:00' # datetime |  (optional)
    group_by = 'day' # str |  (optional) (default to 'day')
    authorization = 'authorization_example' # str | REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. (optional)
    authorization2 = 'authorization_example' # str |  (optional)
    x_namespace = 'x_namespace_example' # str | REQUIRED: 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' (optional)

    try:
        # Get Enrichment History
        api_response = api_instance.get_enrichment_history_analytics_taxonomies_taxonomy(taxonomy_id, start_date=start_date, end_date=end_date, group_by=group_by, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)
        print("The response of AnalyticsApi->get_enrichment_history_analytics_taxonomies_taxonomy:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AnalyticsApi->get_enrichment_history_analytics_taxonomies_taxonomy: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **taxonomy_id** | **str**|  | 
 **start_date** | **datetime**|  | [optional] 
 **end_date** | **datetime**|  | [optional] 
 **group_by** | **str**|  | [optional] [default to 'day']
 **authorization** | **str**| REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. | [optional] 
 **authorization2** | **str**|  | [optional] 
 **x_namespace** | **str**| REQUIRED: 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' | [optional] 

### Return type

[**EnrichmentHistoryResponse**](EnrichmentHistoryResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**400** | Bad Request |  -  |
**401** | Unauthorized |  -  |
**403** | Forbidden |  -  |
**404** | Not Found |  -  |
**422** | Validation Error |  -  |
**500** | Internal Server Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_enrichment_history_analytics_taxonomies_taxonomy_0**
> EnrichmentHistoryResponse get_enrichment_history_analytics_taxonomies_taxonomy_0(taxonomy_id, start_date=start_date, end_date=end_date, group_by=group_by, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)

Get Enrichment History

Get enrichment execution history.

Tracks enrichment operations including:
- Enrichment success rates
- Average latency
- Volume trends

**Use Cases:**
- Monitor enrichment performance
- Track success rates
- Identify performance issues

### Example


```python
import mixpeek
from mixpeek.models.enrichment_history_response import EnrichmentHistoryResponse
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.AnalyticsApi(api_client)
    taxonomy_id = 'taxonomy_id_example' # str | 
    start_date = '2013-10-20T19:20:30+01:00' # datetime |  (optional)
    end_date = '2013-10-20T19:20:30+01:00' # datetime |  (optional)
    group_by = 'day' # str |  (optional) (default to 'day')
    authorization = 'authorization_example' # str | REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. (optional)
    authorization2 = 'authorization_example' # str |  (optional)
    x_namespace = 'x_namespace_example' # str | REQUIRED: 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' (optional)

    try:
        # Get Enrichment History
        api_response = api_instance.get_enrichment_history_analytics_taxonomies_taxonomy_0(taxonomy_id, start_date=start_date, end_date=end_date, group_by=group_by, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)
        print("The response of AnalyticsApi->get_enrichment_history_analytics_taxonomies_taxonomy_0:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AnalyticsApi->get_enrichment_history_analytics_taxonomies_taxonomy_0: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **taxonomy_id** | **str**|  | 
 **start_date** | **datetime**|  | [optional] 
 **end_date** | **datetime**|  | [optional] 
 **group_by** | **str**|  | [optional] [default to 'day']
 **authorization** | **str**| REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. | [optional] 
 **authorization2** | **str**|  | [optional] 
 **x_namespace** | **str**| REQUIRED: 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' | [optional] 

### Return type

[**EnrichmentHistoryResponse**](EnrichmentHistoryResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**400** | Bad Request |  -  |
**401** | Unauthorized |  -  |
**403** | Forbidden |  -  |
**404** | Not Found |  -  |
**422** | Validation Error |  -  |
**500** | Internal Server Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_execution_history_analytics_clusters**
> ExecutionHistoryResponse get_execution_history_analytics_clusters(cluster_id, hours=hours, limit=limit, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)

Get Execution History

Get cluster execution history with metrics.

Provides execution timeline including:
- Execution duration and document counts
- Algorithm and cluster counts
- Success/failure status

**Use Cases:**
- Monitor clustering performance
- Track execution patterns
- Identify execution issues

### Example


```python
import mixpeek
from mixpeek.models.execution_history_response import ExecutionHistoryResponse
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.AnalyticsApi(api_client)
    cluster_id = 'cluster_id_example' # str | 
    hours = 168 # int | Hours of history (optional) (default to 168)
    limit = 100 # int |  (optional) (default to 100)
    authorization = 'authorization_example' # str | REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. (optional)
    authorization2 = 'authorization_example' # str |  (optional)
    x_namespace = 'x_namespace_example' # str | REQUIRED: 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' (optional)

    try:
        # Get Execution History
        api_response = api_instance.get_execution_history_analytics_clusters(cluster_id, hours=hours, limit=limit, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)
        print("The response of AnalyticsApi->get_execution_history_analytics_clusters:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AnalyticsApi->get_execution_history_analytics_clusters: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **cluster_id** | **str**|  | 
 **hours** | **int**| Hours of history | [optional] [default to 168]
 **limit** | **int**|  | [optional] [default to 100]
 **authorization** | **str**| REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. | [optional] 
 **authorization2** | **str**|  | [optional] 
 **x_namespace** | **str**| REQUIRED: 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' | [optional] 

### Return type

[**ExecutionHistoryResponse**](ExecutionHistoryResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**400** | Bad Request |  -  |
**401** | Unauthorized |  -  |
**403** | Forbidden |  -  |
**404** | Not Found |  -  |
**422** | Validation Error |  -  |
**500** | Internal Server Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_execution_history_analytics_clusters_0**
> ExecutionHistoryResponse get_execution_history_analytics_clusters_0(cluster_id, hours=hours, limit=limit, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)

Get Execution History

Get cluster execution history with metrics.

Provides execution timeline including:
- Execution duration and document counts
- Algorithm and cluster counts
- Success/failure status

**Use Cases:**
- Monitor clustering performance
- Track execution patterns
- Identify execution issues

### Example


```python
import mixpeek
from mixpeek.models.execution_history_response import ExecutionHistoryResponse
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.AnalyticsApi(api_client)
    cluster_id = 'cluster_id_example' # str | 
    hours = 168 # int | Hours of history (optional) (default to 168)
    limit = 100 # int |  (optional) (default to 100)
    authorization = 'authorization_example' # str | REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. (optional)
    authorization2 = 'authorization_example' # str |  (optional)
    x_namespace = 'x_namespace_example' # str | REQUIRED: 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' (optional)

    try:
        # Get Execution History
        api_response = api_instance.get_execution_history_analytics_clusters_0(cluster_id, hours=hours, limit=limit, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)
        print("The response of AnalyticsApi->get_execution_history_analytics_clusters_0:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AnalyticsApi->get_execution_history_analytics_clusters_0: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **cluster_id** | **str**|  | 
 **hours** | **int**| Hours of history | [optional] [default to 168]
 **limit** | **int**|  | [optional] [default to 100]
 **authorization** | **str**| REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. | [optional] 
 **authorization2** | **str**|  | [optional] 
 **x_namespace** | **str**| REQUIRED: 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' | [optional] 

### Return type

[**ExecutionHistoryResponse**](ExecutionHistoryResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**400** | Bad Request |  -  |
**401** | Unauthorized |  -  |
**403** | Forbidden |  -  |
**404** | Not Found |  -  |
**422** | Validation Error |  -  |
**500** | Internal Server Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_extractor_breakdown_analytics_performance_engine**
> ExtractorBreakdownResponse get_extractor_breakdown_analytics_performance_engine(hours=hours, start_date=start_date, end_date=end_date, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)

Get Extractor Breakdown

Get extractor performance breakdown.

Shows performance metrics for each extractor and its stages.

**Use Cases:**
- Compare performance across extractors
- Identify slow extractor stages
- Monitor specific extractor performance

**Response:**
- Per-extractor, per-stage metrics
- Execution counts
- Latency statistics (avg, p95, max)

**Example:**
```bash
GET /v1/analytics/performance/engine/extractors?hours=24
```

### Example


```python
import mixpeek
from mixpeek.models.extractor_breakdown_response import ExtractorBreakdownResponse
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.AnalyticsApi(api_client)
    hours = 56 # int | Hours of history (optional)
    start_date = '2013-10-20T19:20:30+01:00' # datetime | Start date (optional)
    end_date = '2013-10-20T19:20:30+01:00' # datetime | End date (optional)
    authorization = 'authorization_example' # str | REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. (optional)
    authorization2 = 'authorization_example' # str |  (optional)
    x_namespace = 'x_namespace_example' # str | REQUIRED: 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' (optional)

    try:
        # Get Extractor Breakdown
        api_response = api_instance.get_extractor_breakdown_analytics_performance_engine(hours=hours, start_date=start_date, end_date=end_date, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)
        print("The response of AnalyticsApi->get_extractor_breakdown_analytics_performance_engine:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AnalyticsApi->get_extractor_breakdown_analytics_performance_engine: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **hours** | **int**| Hours of history | [optional] 
 **start_date** | **datetime**| Start date | [optional] 
 **end_date** | **datetime**| End date | [optional] 
 **authorization** | **str**| REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. | [optional] 
 **authorization2** | **str**|  | [optional] 
 **x_namespace** | **str**| REQUIRED: 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' | [optional] 

### Return type

[**ExtractorBreakdownResponse**](ExtractorBreakdownResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**400** | Bad Request |  -  |
**401** | Unauthorized |  -  |
**403** | Forbidden |  -  |
**404** | Not Found |  -  |
**422** | Validation Error |  -  |
**500** | Internal Server Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_extractor_breakdown_analytics_performance_engine_0**
> ExtractorBreakdownResponse get_extractor_breakdown_analytics_performance_engine_0(hours=hours, start_date=start_date, end_date=end_date, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)

Get Extractor Breakdown

Get extractor performance breakdown.

Shows performance metrics for each extractor and its stages.

**Use Cases:**
- Compare performance across extractors
- Identify slow extractor stages
- Monitor specific extractor performance

**Response:**
- Per-extractor, per-stage metrics
- Execution counts
- Latency statistics (avg, p95, max)

**Example:**
```bash
GET /v1/analytics/performance/engine/extractors?hours=24
```

### Example


```python
import mixpeek
from mixpeek.models.extractor_breakdown_response import ExtractorBreakdownResponse
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.AnalyticsApi(api_client)
    hours = 56 # int | Hours of history (optional)
    start_date = '2013-10-20T19:20:30+01:00' # datetime | Start date (optional)
    end_date = '2013-10-20T19:20:30+01:00' # datetime | End date (optional)
    authorization = 'authorization_example' # str | REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. (optional)
    authorization2 = 'authorization_example' # str |  (optional)
    x_namespace = 'x_namespace_example' # str | REQUIRED: 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' (optional)

    try:
        # Get Extractor Breakdown
        api_response = api_instance.get_extractor_breakdown_analytics_performance_engine_0(hours=hours, start_date=start_date, end_date=end_date, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)
        print("The response of AnalyticsApi->get_extractor_breakdown_analytics_performance_engine_0:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AnalyticsApi->get_extractor_breakdown_analytics_performance_engine_0: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **hours** | **int**| Hours of history | [optional] 
 **start_date** | **datetime**| Start date | [optional] 
 **end_date** | **datetime**| End date | [optional] 
 **authorization** | **str**| REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. | [optional] 
 **authorization2** | **str**|  | [optional] 
 **x_namespace** | **str**| REQUIRED: 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' | [optional] 

### Return type

[**ExtractorBreakdownResponse**](ExtractorBreakdownResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**400** | Bad Request |  -  |
**401** | Unauthorized |  -  |
**403** | Forbidden |  -  |
**404** | Not Found |  -  |
**422** | Validation Error |  -  |
**500** | Internal Server Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_extractor_performance_analytics**
> List[Dict[str, object]] get_extractor_performance_analytics(extractor_name=extractor_name, hours=hours, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)

Get Extractor Performance

Get feature extraction performance metrics.

Returns performance metrics for feature extractors including:
- Total executions per extractor
- Average duration
- P95/P99 latencies
- Success/failure rates

**Example:**
```bash
GET /v1/analytics/extractors/performance?hours=24
GET /v1/analytics/extractors/performance?extractor_name=text_extractor&hours=168
```

### Example


```python
import mixpeek
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.AnalyticsApi(api_client)
    extractor_name = 'extractor_name_example' # str | Filter by extractor (optional)
    hours = 24 # int | Hours of history (optional) (default to 24)
    authorization = 'authorization_example' # str | REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. (optional)
    authorization2 = 'authorization_example' # str |  (optional)
    x_namespace = 'x_namespace_example' # str | REQUIRED: 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' (optional)

    try:
        # Get Extractor Performance
        api_response = api_instance.get_extractor_performance_analytics(extractor_name=extractor_name, hours=hours, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)
        print("The response of AnalyticsApi->get_extractor_performance_analytics:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AnalyticsApi->get_extractor_performance_analytics: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **extractor_name** | **str**| Filter by extractor | [optional] 
 **hours** | **int**| Hours of history | [optional] [default to 24]
 **authorization** | **str**| REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. | [optional] 
 **authorization2** | **str**|  | [optional] 
 **x_namespace** | **str**| REQUIRED: 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' | [optional] 

### Return type

**List[Dict[str, object]]**

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**400** | Bad Request |  -  |
**401** | Unauthorized |  -  |
**403** | Forbidden |  -  |
**404** | Not Found |  -  |
**422** | Validation Error |  -  |
**500** | Internal Server Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_extractor_performance_analytics_0**
> List[Dict[str, object]] get_extractor_performance_analytics_0(extractor_name=extractor_name, hours=hours, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)

Get Extractor Performance

Get feature extraction performance metrics.

Returns performance metrics for feature extractors including:
- Total executions per extractor
- Average duration
- P95/P99 latencies
- Success/failure rates

**Example:**
```bash
GET /v1/analytics/extractors/performance?hours=24
GET /v1/analytics/extractors/performance?extractor_name=text_extractor&hours=168
```

### Example


```python
import mixpeek
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.AnalyticsApi(api_client)
    extractor_name = 'extractor_name_example' # str | Filter by extractor (optional)
    hours = 24 # int | Hours of history (optional) (default to 24)
    authorization = 'authorization_example' # str | REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. (optional)
    authorization2 = 'authorization_example' # str |  (optional)
    x_namespace = 'x_namespace_example' # str | REQUIRED: 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' (optional)

    try:
        # Get Extractor Performance
        api_response = api_instance.get_extractor_performance_analytics_0(extractor_name=extractor_name, hours=hours, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)
        print("The response of AnalyticsApi->get_extractor_performance_analytics_0:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AnalyticsApi->get_extractor_performance_analytics_0: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **extractor_name** | **str**| Filter by extractor | [optional] 
 **hours** | **int**| Hours of history | [optional] [default to 24]
 **authorization** | **str**| REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. | [optional] 
 **authorization2** | **str**|  | [optional] 
 **x_namespace** | **str**| REQUIRED: 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' | [optional] 

### Return type

**List[Dict[str, object]]**

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**400** | Bad Request |  -  |
**401** | Unauthorized |  -  |
**403** | Forbidden |  -  |
**404** | Not Found |  -  |
**422** | Validation Error |  -  |
**500** | Internal Server Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_extractor_performance_analytics_1**
> ExtractorPerformanceResponse get_extractor_performance_analytics_1(collection_id, hours=hours, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)

Get Extractor Performance

Get feature extractor performance breakdown.

Analyzes extractor execution metrics including:
- Execution counts and success/failure rates
- Latency percentiles (P95, P99)
- Total processing time

**Use Cases:**
- Identify slow extractors for optimization
- Monitor extraction success rates
- Understanding processing bottlenecks

### Example


```python
import mixpeek
from mixpeek.models.extractor_performance_response import ExtractorPerformanceResponse
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.AnalyticsApi(api_client)
    collection_id = 'collection_id_example' # str | 
    hours = 24 # int |  (optional) (default to 24)
    authorization = 'authorization_example' # str | REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. (optional)
    authorization2 = 'authorization_example' # str |  (optional)
    x_namespace = 'x_namespace_example' # str | REQUIRED: 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' (optional)

    try:
        # Get Extractor Performance
        api_response = api_instance.get_extractor_performance_analytics_1(collection_id, hours=hours, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)
        print("The response of AnalyticsApi->get_extractor_performance_analytics_1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AnalyticsApi->get_extractor_performance_analytics_1: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **collection_id** | **str**|  | 
 **hours** | **int**|  | [optional] [default to 24]
 **authorization** | **str**| REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. | [optional] 
 **authorization2** | **str**|  | [optional] 
 **x_namespace** | **str**| REQUIRED: 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' | [optional] 

### Return type

[**ExtractorPerformanceResponse**](ExtractorPerformanceResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**400** | Bad Request |  -  |
**401** | Unauthorized |  -  |
**403** | Forbidden |  -  |
**404** | Not Found |  -  |
**422** | Validation Error |  -  |
**500** | Internal Server Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_extractor_performance_analytics_2**
> ExtractorPerformanceResponse get_extractor_performance_analytics_2(collection_id, hours=hours, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)

Get Extractor Performance

Get feature extractor performance breakdown.

Analyzes extractor execution metrics including:
- Execution counts and success/failure rates
- Latency percentiles (P95, P99)
- Total processing time

**Use Cases:**
- Identify slow extractors for optimization
- Monitor extraction success rates
- Understanding processing bottlenecks

### Example


```python
import mixpeek
from mixpeek.models.extractor_performance_response import ExtractorPerformanceResponse
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.AnalyticsApi(api_client)
    collection_id = 'collection_id_example' # str | 
    hours = 24 # int |  (optional) (default to 24)
    authorization = 'authorization_example' # str | REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. (optional)
    authorization2 = 'authorization_example' # str |  (optional)
    x_namespace = 'x_namespace_example' # str | REQUIRED: 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' (optional)

    try:
        # Get Extractor Performance
        api_response = api_instance.get_extractor_performance_analytics_2(collection_id, hours=hours, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)
        print("The response of AnalyticsApi->get_extractor_performance_analytics_2:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AnalyticsApi->get_extractor_performance_analytics_2: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **collection_id** | **str**|  | 
 **hours** | **int**|  | [optional] [default to 24]
 **authorization** | **str**| REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. | [optional] 
 **authorization2** | **str**|  | [optional] 
 **x_namespace** | **str**| REQUIRED: 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' | [optional] 

### Return type

[**ExtractorPerformanceResponse**](ExtractorPerformanceResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**400** | Bad Request |  -  |
**401** | Unauthorized |  -  |
**403** | Forbidden |  -  |
**404** | Not Found |  -  |
**422** | Validation Error |  -  |
**500** | Internal Server Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_failure_analysis_analytics**
> ApiAnalyticsCollectionsModelsFailureAnalysisResponse get_failure_analysis_analytics(collection_id, hours=hours, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)

Get Failure Analysis

Get failure analysis metrics.

Debug processing failures including:
- Error distribution by type
- Recent error messages
- Failure patterns

**Use Cases:**
- Debug processing failures
- Identify common error patterns
- Track error trends

### Example


```python
import mixpeek
from mixpeek.models.api_analytics_collections_models_failure_analysis_response import ApiAnalyticsCollectionsModelsFailureAnalysisResponse
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.AnalyticsApi(api_client)
    collection_id = 'collection_id_example' # str | 
    hours = 72 # int |  (optional) (default to 72)
    authorization = 'authorization_example' # str | REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. (optional)
    authorization2 = 'authorization_example' # str |  (optional)
    x_namespace = 'x_namespace_example' # str | REQUIRED: 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' (optional)

    try:
        # Get Failure Analysis
        api_response = api_instance.get_failure_analysis_analytics(collection_id, hours=hours, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)
        print("The response of AnalyticsApi->get_failure_analysis_analytics:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AnalyticsApi->get_failure_analysis_analytics: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **collection_id** | **str**|  | 
 **hours** | **int**|  | [optional] [default to 72]
 **authorization** | **str**| REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. | [optional] 
 **authorization2** | **str**|  | [optional] 
 **x_namespace** | **str**| REQUIRED: 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' | [optional] 

### Return type

[**ApiAnalyticsCollectionsModelsFailureAnalysisResponse**](ApiAnalyticsCollectionsModelsFailureAnalysisResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**400** | Bad Request |  -  |
**401** | Unauthorized |  -  |
**403** | Forbidden |  -  |
**404** | Not Found |  -  |
**422** | Validation Error |  -  |
**500** | Internal Server Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_failure_analysis_analytics_0**
> ApiAnalyticsCollectionsModelsFailureAnalysisResponse get_failure_analysis_analytics_0(collection_id, hours=hours, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)

Get Failure Analysis

Get failure analysis metrics.

Debug processing failures including:
- Error distribution by type
- Recent error messages
- Failure patterns

**Use Cases:**
- Debug processing failures
- Identify common error patterns
- Track error trends

### Example


```python
import mixpeek
from mixpeek.models.api_analytics_collections_models_failure_analysis_response import ApiAnalyticsCollectionsModelsFailureAnalysisResponse
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.AnalyticsApi(api_client)
    collection_id = 'collection_id_example' # str | 
    hours = 72 # int |  (optional) (default to 72)
    authorization = 'authorization_example' # str | REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. (optional)
    authorization2 = 'authorization_example' # str |  (optional)
    x_namespace = 'x_namespace_example' # str | REQUIRED: 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' (optional)

    try:
        # Get Failure Analysis
        api_response = api_instance.get_failure_analysis_analytics_0(collection_id, hours=hours, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)
        print("The response of AnalyticsApi->get_failure_analysis_analytics_0:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AnalyticsApi->get_failure_analysis_analytics_0: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **collection_id** | **str**|  | 
 **hours** | **int**|  | [optional] [default to 72]
 **authorization** | **str**| REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. | [optional] 
 **authorization2** | **str**|  | [optional] 
 **x_namespace** | **str**| REQUIRED: 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' | [optional] 

### Return type

[**ApiAnalyticsCollectionsModelsFailureAnalysisResponse**](ApiAnalyticsCollectionsModelsFailureAnalysisResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**400** | Bad Request |  -  |
**401** | Unauthorized |  -  |
**403** | Forbidden |  -  |
**404** | Not Found |  -  |
**422** | Validation Error |  -  |
**500** | Internal Server Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_failure_analysis_analytics_clusters**
> ApiAnalyticsClustersModelsFailureAnalysisResponse get_failure_analysis_analytics_clusters(cluster_id, hours=hours, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)

Get Failure Analysis

Get cluster failure analysis.

Analyzes clustering failures including:
- Error messages and types
- Failure timestamps
- Failure patterns

**Use Cases:**
- Debug clustering failures
- Identify common error patterns
- Monitor cluster health

### Example


```python
import mixpeek
from mixpeek.models.api_analytics_clusters_models_failure_analysis_response import ApiAnalyticsClustersModelsFailureAnalysisResponse
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.AnalyticsApi(api_client)
    cluster_id = 'cluster_id_example' # str | 
    hours = 168 # int |  (optional) (default to 168)
    authorization = 'authorization_example' # str | REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. (optional)
    authorization2 = 'authorization_example' # str |  (optional)
    x_namespace = 'x_namespace_example' # str | REQUIRED: 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' (optional)

    try:
        # Get Failure Analysis
        api_response = api_instance.get_failure_analysis_analytics_clusters(cluster_id, hours=hours, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)
        print("The response of AnalyticsApi->get_failure_analysis_analytics_clusters:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AnalyticsApi->get_failure_analysis_analytics_clusters: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **cluster_id** | **str**|  | 
 **hours** | **int**|  | [optional] [default to 168]
 **authorization** | **str**| REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. | [optional] 
 **authorization2** | **str**|  | [optional] 
 **x_namespace** | **str**| REQUIRED: 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' | [optional] 

### Return type

[**ApiAnalyticsClustersModelsFailureAnalysisResponse**](ApiAnalyticsClustersModelsFailureAnalysisResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**400** | Bad Request |  -  |
**401** | Unauthorized |  -  |
**403** | Forbidden |  -  |
**404** | Not Found |  -  |
**422** | Validation Error |  -  |
**500** | Internal Server Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_failure_analysis_analytics_clusters_0**
> ApiAnalyticsClustersModelsFailureAnalysisResponse get_failure_analysis_analytics_clusters_0(cluster_id, hours=hours, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)

Get Failure Analysis

Get cluster failure analysis.

Analyzes clustering failures including:
- Error messages and types
- Failure timestamps
- Failure patterns

**Use Cases:**
- Debug clustering failures
- Identify common error patterns
- Monitor cluster health

### Example


```python
import mixpeek
from mixpeek.models.api_analytics_clusters_models_failure_analysis_response import ApiAnalyticsClustersModelsFailureAnalysisResponse
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.AnalyticsApi(api_client)
    cluster_id = 'cluster_id_example' # str | 
    hours = 168 # int |  (optional) (default to 168)
    authorization = 'authorization_example' # str | REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. (optional)
    authorization2 = 'authorization_example' # str |  (optional)
    x_namespace = 'x_namespace_example' # str | REQUIRED: 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' (optional)

    try:
        # Get Failure Analysis
        api_response = api_instance.get_failure_analysis_analytics_clusters_0(cluster_id, hours=hours, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)
        print("The response of AnalyticsApi->get_failure_analysis_analytics_clusters_0:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AnalyticsApi->get_failure_analysis_analytics_clusters_0: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **cluster_id** | **str**|  | 
 **hours** | **int**|  | [optional] [default to 168]
 **authorization** | **str**| REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. | [optional] 
 **authorization2** | **str**|  | [optional] 
 **x_namespace** | **str**| REQUIRED: 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' | [optional] 

### Return type

[**ApiAnalyticsClustersModelsFailureAnalysisResponse**](ApiAnalyticsClustersModelsFailureAnalysisResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**400** | Bad Request |  -  |
**401** | Unauthorized |  -  |
**403** | Forbidden |  -  |
**404** | Not Found |  -  |
**422** | Validation Error |  -  |
**500** | Internal Server Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_field_performance_analytics_namespaces**
> FieldPerformanceResponse get_field_performance_analytics_namespaces(days=days, limit=limit, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)

Get Field Performance

Analyze field performance correlation.

Shows which metadata fields correlate with slow queries, helping identify
fields that would benefit most from indexing.

**Use Cases:**
- Identify fields causing performance issues
- Quantify indexing impact potential
- Prioritize index creation
- Monitor field usage patterns

**Response Includes:**
- Field usage count
- Latency statistics (avg, P50, P95, P99, max)
- Index priority score (usage × latency)
- Sorted by priority score

**Index Priority Score:**
Higher scores indicate fields where indexing would have greatest impact.
Score = (query count) × (average latency)

**Example:**
```bash
curl -X GET "https://api.mixpeek.com/v1/analytics/namespaces/fields/performance?days=30" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "X-Namespace: your-namespace"
```

### Example


```python
import mixpeek
from mixpeek.models.field_performance_response import FieldPerformanceResponse
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.AnalyticsApi(api_client)
    days = 30 # int | Days of history to analyze (optional) (default to 30)
    limit = 50 # int | Maximum fields to return (optional) (default to 50)
    authorization = 'authorization_example' # str | REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. (optional)
    authorization2 = 'authorization_example' # str |  (optional)
    x_namespace = 'x_namespace_example' # str | REQUIRED: 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' (optional)

    try:
        # Get Field Performance
        api_response = api_instance.get_field_performance_analytics_namespaces(days=days, limit=limit, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)
        print("The response of AnalyticsApi->get_field_performance_analytics_namespaces:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AnalyticsApi->get_field_performance_analytics_namespaces: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **days** | **int**| Days of history to analyze | [optional] [default to 30]
 **limit** | **int**| Maximum fields to return | [optional] [default to 50]
 **authorization** | **str**| REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. | [optional] 
 **authorization2** | **str**|  | [optional] 
 **x_namespace** | **str**| REQUIRED: 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' | [optional] 

### Return type

[**FieldPerformanceResponse**](FieldPerformanceResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**400** | Bad Request |  -  |
**401** | Unauthorized |  -  |
**403** | Forbidden |  -  |
**404** | Not Found |  -  |
**422** | Validation Error |  -  |
**500** | Internal Server Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_field_performance_analytics_namespaces_0**
> FieldPerformanceResponse get_field_performance_analytics_namespaces_0(days=days, limit=limit, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)

Get Field Performance

Analyze field performance correlation.

Shows which metadata fields correlate with slow queries, helping identify
fields that would benefit most from indexing.

**Use Cases:**
- Identify fields causing performance issues
- Quantify indexing impact potential
- Prioritize index creation
- Monitor field usage patterns

**Response Includes:**
- Field usage count
- Latency statistics (avg, P50, P95, P99, max)
- Index priority score (usage × latency)
- Sorted by priority score

**Index Priority Score:**
Higher scores indicate fields where indexing would have greatest impact.
Score = (query count) × (average latency)

**Example:**
```bash
curl -X GET "https://api.mixpeek.com/v1/analytics/namespaces/fields/performance?days=30" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "X-Namespace: your-namespace"
```

### Example


```python
import mixpeek
from mixpeek.models.field_performance_response import FieldPerformanceResponse
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.AnalyticsApi(api_client)
    days = 30 # int | Days of history to analyze (optional) (default to 30)
    limit = 50 # int | Maximum fields to return (optional) (default to 50)
    authorization = 'authorization_example' # str | REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. (optional)
    authorization2 = 'authorization_example' # str |  (optional)
    x_namespace = 'x_namespace_example' # str | REQUIRED: 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' (optional)

    try:
        # Get Field Performance
        api_response = api_instance.get_field_performance_analytics_namespaces_0(days=days, limit=limit, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)
        print("The response of AnalyticsApi->get_field_performance_analytics_namespaces_0:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AnalyticsApi->get_field_performance_analytics_namespaces_0: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **days** | **int**| Days of history to analyze | [optional] [default to 30]
 **limit** | **int**| Maximum fields to return | [optional] [default to 50]
 **authorization** | **str**| REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. | [optional] 
 **authorization2** | **str**|  | [optional] 
 **x_namespace** | **str**| REQUIRED: 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' | [optional] 

### Return type

[**FieldPerformanceResponse**](FieldPerformanceResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**400** | Bad Request |  -  |
**401** | Unauthorized |  -  |
**403** | Forbidden |  -  |
**404** | Not Found |  -  |
**422** | Validation Error |  -  |
**500** | Internal Server Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_field_usage_analytics_indexes**
> FieldUsageResponse get_field_usage_analytics_indexes(period=period, min_count=min_count, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)

Get Field Usage

Get usage statistics for all filtered fields.

### Example


```python
import mixpeek
from mixpeek.models.field_usage_response import FieldUsageResponse
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.AnalyticsApi(api_client)
    period = '24h' # str | Time period: Xh (hours) or Xd (days), e.g., 24h, 7d, 30d (optional) (default to '24h')
    min_count = 1 # int | Minimum query count to include a field (optional) (default to 1)
    authorization = 'authorization_example' # str | REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. (optional)
    authorization2 = 'authorization_example' # str |  (optional)
    x_namespace = 'x_namespace_example' # str | REQUIRED: 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' (optional)

    try:
        # Get Field Usage
        api_response = api_instance.get_field_usage_analytics_indexes(period=period, min_count=min_count, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)
        print("The response of AnalyticsApi->get_field_usage_analytics_indexes:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AnalyticsApi->get_field_usage_analytics_indexes: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **period** | **str**| Time period: Xh (hours) or Xd (days), e.g., 24h, 7d, 30d | [optional] [default to '24h']
 **min_count** | **int**| Minimum query count to include a field | [optional] [default to 1]
 **authorization** | **str**| REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. | [optional] 
 **authorization2** | **str**|  | [optional] 
 **x_namespace** | **str**| REQUIRED: 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' | [optional] 

### Return type

[**FieldUsageResponse**](FieldUsageResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**400** | Bad Request |  -  |
**401** | Unauthorized |  -  |
**403** | Forbidden |  -  |
**404** | Not Found |  -  |
**422** | Validation Error |  -  |
**500** | Internal Server Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_field_usage_analytics_indexes_0**
> FieldUsageResponse get_field_usage_analytics_indexes_0(period=period, min_count=min_count, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)

Get Field Usage

Get usage statistics for all filtered fields.

### Example


```python
import mixpeek
from mixpeek.models.field_usage_response import FieldUsageResponse
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.AnalyticsApi(api_client)
    period = '24h' # str | Time period: Xh (hours) or Xd (days), e.g., 24h, 7d, 30d (optional) (default to '24h')
    min_count = 1 # int | Minimum query count to include a field (optional) (default to 1)
    authorization = 'authorization_example' # str | REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. (optional)
    authorization2 = 'authorization_example' # str |  (optional)
    x_namespace = 'x_namespace_example' # str | REQUIRED: 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' (optional)

    try:
        # Get Field Usage
        api_response = api_instance.get_field_usage_analytics_indexes_0(period=period, min_count=min_count, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)
        print("The response of AnalyticsApi->get_field_usage_analytics_indexes_0:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AnalyticsApi->get_field_usage_analytics_indexes_0: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **period** | **str**| Time period: Xh (hours) or Xd (days), e.g., 24h, 7d, 30d | [optional] [default to '24h']
 **min_count** | **int**| Minimum query count to include a field | [optional] [default to 1]
 **authorization** | **str**| REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. | [optional] 
 **authorization2** | **str**|  | [optional] 
 **x_namespace** | **str**| REQUIRED: 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' | [optional] 

### Return type

[**FieldUsageResponse**](FieldUsageResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**400** | Bad Request |  -  |
**401** | Unauthorized |  -  |
**403** | Forbidden |  -  |
**404** | Not Found |  -  |
**422** | Validation Error |  -  |
**500** | Internal Server Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_index_recommendations_analytics_namespaces_indexes**
> IndexRecommendationsResponse get_index_recommendations_analytics_namespaces_indexes(days=days, min_usage_count=min_usage_count, limit=limit, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)

Get Index Recommendations

Get comprehensive MongoDB index recommendations.

Analyzes query patterns and generates prioritized index recommendations
with ready-to-use MongoDB commands.

**Use Cases:**
- Get actionable index suggestions
- Prioritize database optimization
- Copy/paste index creation commands
- Track optimization opportunities

**Recommendation Levels:**
- **HIGH PRIORITY**: >100 queries, >300ms avg OR >10 very slow queries
- **MEDIUM PRIORITY**: >50 queries, >200ms avg OR >20 slow queries
- **LOW PRIORITY**: >10 queries but acceptable performance
- **NO ACTION**: Low usage, no optimization needed

**Response Includes:**
- Prioritized recommendations
- Usage and latency statistics
- MongoDB index creation commands
- Summary by priority level

**Example:**
```bash
curl -X GET "https://api.mixpeek.com/v1/analytics/namespaces/indexes/recommendations" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "X-Namespace: your-namespace"
```

### Example


```python
import mixpeek
from mixpeek.models.index_recommendations_response import IndexRecommendationsResponse
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.AnalyticsApi(api_client)
    days = 30 # int | Days of history to analyze (optional) (default to 30)
    min_usage_count = 5 # int | Minimum queries to consider (optional) (default to 5)
    limit = 50 # int | Maximum recommendations to return (optional) (default to 50)
    authorization = 'authorization_example' # str | REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. (optional)
    authorization2 = 'authorization_example' # str |  (optional)
    x_namespace = 'x_namespace_example' # str | REQUIRED: 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' (optional)

    try:
        # Get Index Recommendations
        api_response = api_instance.get_index_recommendations_analytics_namespaces_indexes(days=days, min_usage_count=min_usage_count, limit=limit, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)
        print("The response of AnalyticsApi->get_index_recommendations_analytics_namespaces_indexes:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AnalyticsApi->get_index_recommendations_analytics_namespaces_indexes: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **days** | **int**| Days of history to analyze | [optional] [default to 30]
 **min_usage_count** | **int**| Minimum queries to consider | [optional] [default to 5]
 **limit** | **int**| Maximum recommendations to return | [optional] [default to 50]
 **authorization** | **str**| REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. | [optional] 
 **authorization2** | **str**|  | [optional] 
 **x_namespace** | **str**| REQUIRED: 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' | [optional] 

### Return type

[**IndexRecommendationsResponse**](IndexRecommendationsResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**400** | Bad Request |  -  |
**401** | Unauthorized |  -  |
**403** | Forbidden |  -  |
**404** | Not Found |  -  |
**422** | Validation Error |  -  |
**500** | Internal Server Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_index_recommendations_analytics_namespaces_indexes_0**
> IndexRecommendationsResponse get_index_recommendations_analytics_namespaces_indexes_0(days=days, min_usage_count=min_usage_count, limit=limit, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)

Get Index Recommendations

Get comprehensive MongoDB index recommendations.

Analyzes query patterns and generates prioritized index recommendations
with ready-to-use MongoDB commands.

**Use Cases:**
- Get actionable index suggestions
- Prioritize database optimization
- Copy/paste index creation commands
- Track optimization opportunities

**Recommendation Levels:**
- **HIGH PRIORITY**: >100 queries, >300ms avg OR >10 very slow queries
- **MEDIUM PRIORITY**: >50 queries, >200ms avg OR >20 slow queries
- **LOW PRIORITY**: >10 queries but acceptable performance
- **NO ACTION**: Low usage, no optimization needed

**Response Includes:**
- Prioritized recommendations
- Usage and latency statistics
- MongoDB index creation commands
- Summary by priority level

**Example:**
```bash
curl -X GET "https://api.mixpeek.com/v1/analytics/namespaces/indexes/recommendations" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "X-Namespace: your-namespace"
```

### Example


```python
import mixpeek
from mixpeek.models.index_recommendations_response import IndexRecommendationsResponse
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.AnalyticsApi(api_client)
    days = 30 # int | Days of history to analyze (optional) (default to 30)
    min_usage_count = 5 # int | Minimum queries to consider (optional) (default to 5)
    limit = 50 # int | Maximum recommendations to return (optional) (default to 50)
    authorization = 'authorization_example' # str | REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. (optional)
    authorization2 = 'authorization_example' # str |  (optional)
    x_namespace = 'x_namespace_example' # str | REQUIRED: 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' (optional)

    try:
        # Get Index Recommendations
        api_response = api_instance.get_index_recommendations_analytics_namespaces_indexes_0(days=days, min_usage_count=min_usage_count, limit=limit, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)
        print("The response of AnalyticsApi->get_index_recommendations_analytics_namespaces_indexes_0:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AnalyticsApi->get_index_recommendations_analytics_namespaces_indexes_0: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **days** | **int**| Days of history to analyze | [optional] [default to 30]
 **min_usage_count** | **int**| Minimum queries to consider | [optional] [default to 5]
 **limit** | **int**| Maximum recommendations to return | [optional] [default to 50]
 **authorization** | **str**| REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. | [optional] 
 **authorization2** | **str**|  | [optional] 
 **x_namespace** | **str**| REQUIRED: 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' | [optional] 

### Return type

[**IndexRecommendationsResponse**](IndexRecommendationsResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**400** | Bad Request |  -  |
**401** | Unauthorized |  -  |
**403** | Forbidden |  -  |
**404** | Not Found |  -  |
**422** | Validation Error |  -  |
**500** | Internal Server Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_index_suggestions_analytics_indexes**
> IndexSuggestionsResponse get_index_suggestions_analytics_indexes(hours=hours, min_count=min_count, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)

Get Index Suggestions

Get index suggestions based on filter usage patterns.

### Example


```python
import mixpeek
from mixpeek.models.index_suggestions_response import IndexSuggestionsResponse
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.AnalyticsApi(api_client)
    hours = 24 # int | Time window in hours to analyze (max 30 days) (optional) (default to 24)
    min_count = 100 # int | Minimum query count threshold for suggestions (optional) (default to 100)
    authorization = 'authorization_example' # str | REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. (optional)
    authorization2 = 'authorization_example' # str |  (optional)
    x_namespace = 'x_namespace_example' # str | REQUIRED: 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' (optional)

    try:
        # Get Index Suggestions
        api_response = api_instance.get_index_suggestions_analytics_indexes(hours=hours, min_count=min_count, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)
        print("The response of AnalyticsApi->get_index_suggestions_analytics_indexes:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AnalyticsApi->get_index_suggestions_analytics_indexes: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **hours** | **int**| Time window in hours to analyze (max 30 days) | [optional] [default to 24]
 **min_count** | **int**| Minimum query count threshold for suggestions | [optional] [default to 100]
 **authorization** | **str**| REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. | [optional] 
 **authorization2** | **str**|  | [optional] 
 **x_namespace** | **str**| REQUIRED: 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' | [optional] 

### Return type

[**IndexSuggestionsResponse**](IndexSuggestionsResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**400** | Bad Request |  -  |
**401** | Unauthorized |  -  |
**403** | Forbidden |  -  |
**404** | Not Found |  -  |
**422** | Validation Error |  -  |
**500** | Internal Server Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_index_suggestions_analytics_indexes_0**
> IndexSuggestionsResponse get_index_suggestions_analytics_indexes_0(hours=hours, min_count=min_count, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)

Get Index Suggestions

Get index suggestions based on filter usage patterns.

### Example


```python
import mixpeek
from mixpeek.models.index_suggestions_response import IndexSuggestionsResponse
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.AnalyticsApi(api_client)
    hours = 24 # int | Time window in hours to analyze (max 30 days) (optional) (default to 24)
    min_count = 100 # int | Minimum query count threshold for suggestions (optional) (default to 100)
    authorization = 'authorization_example' # str | REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. (optional)
    authorization2 = 'authorization_example' # str |  (optional)
    x_namespace = 'x_namespace_example' # str | REQUIRED: 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' (optional)

    try:
        # Get Index Suggestions
        api_response = api_instance.get_index_suggestions_analytics_indexes_0(hours=hours, min_count=min_count, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)
        print("The response of AnalyticsApi->get_index_suggestions_analytics_indexes_0:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AnalyticsApi->get_index_suggestions_analytics_indexes_0: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **hours** | **int**| Time window in hours to analyze (max 30 days) | [optional] [default to 24]
 **min_count** | **int**| Minimum query count threshold for suggestions | [optional] [default to 100]
 **authorization** | **str**| REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. | [optional] 
 **authorization2** | **str**|  | [optional] 
 **x_namespace** | **str**| REQUIRED: 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' | [optional] 

### Return type

[**IndexSuggestionsResponse**](IndexSuggestionsResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**400** | Bad Request |  -  |
**401** | Unauthorized |  -  |
**403** | Forbidden |  -  |
**404** | Not Found |  -  |
**422** | Validation Error |  -  |
**500** | Internal Server Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_inference_performance_analytics**
> List[Dict[str, object]] get_inference_performance_analytics(model_name=model_name, hours=hours, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)

Get Inference Performance

Get inference performance metrics.

TODO: Implement inference performance query logic.

### Example


```python
import mixpeek
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.AnalyticsApi(api_client)
    model_name = 'model_name_example' # str | Filter by model (optional)
    hours = 24 # int | Hours of history (optional) (default to 24)
    authorization = 'authorization_example' # str | REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. (optional)
    authorization2 = 'authorization_example' # str |  (optional)
    x_namespace = 'x_namespace_example' # str | REQUIRED: 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' (optional)

    try:
        # Get Inference Performance
        api_response = api_instance.get_inference_performance_analytics(model_name=model_name, hours=hours, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)
        print("The response of AnalyticsApi->get_inference_performance_analytics:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AnalyticsApi->get_inference_performance_analytics: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **model_name** | **str**| Filter by model | [optional] 
 **hours** | **int**| Hours of history | [optional] [default to 24]
 **authorization** | **str**| REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. | [optional] 
 **authorization2** | **str**|  | [optional] 
 **x_namespace** | **str**| REQUIRED: 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' | [optional] 

### Return type

**List[Dict[str, object]]**

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**400** | Bad Request |  -  |
**401** | Unauthorized |  -  |
**403** | Forbidden |  -  |
**404** | Not Found |  -  |
**422** | Validation Error |  -  |
**500** | Internal Server Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_inference_performance_analytics_0**
> List[Dict[str, object]] get_inference_performance_analytics_0(model_name=model_name, hours=hours, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)

Get Inference Performance

Get inference performance metrics.

TODO: Implement inference performance query logic.

### Example


```python
import mixpeek
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.AnalyticsApi(api_client)
    model_name = 'model_name_example' # str | Filter by model (optional)
    hours = 24 # int | Hours of history (optional) (default to 24)
    authorization = 'authorization_example' # str | REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. (optional)
    authorization2 = 'authorization_example' # str |  (optional)
    x_namespace = 'x_namespace_example' # str | REQUIRED: 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' (optional)

    try:
        # Get Inference Performance
        api_response = api_instance.get_inference_performance_analytics_0(model_name=model_name, hours=hours, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)
        print("The response of AnalyticsApi->get_inference_performance_analytics_0:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AnalyticsApi->get_inference_performance_analytics_0: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **model_name** | **str**| Filter by model | [optional] 
 **hours** | **int**| Hours of history | [optional] [default to 24]
 **authorization** | **str**| REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. | [optional] 
 **authorization2** | **str**|  | [optional] 
 **x_namespace** | **str**| REQUIRED: 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' | [optional] 

### Return type

**List[Dict[str, object]]**

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**400** | Bad Request |  -  |
**401** | Unauthorized |  -  |
**403** | Forbidden |  -  |
**404** | Not Found |  -  |
**422** | Validation Error |  -  |
**500** | Internal Server Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_label_distribution_analytics_taxonomies_taxonomy**
> LabelDistributionResponse get_label_distribution_analytics_taxonomies_taxonomy(taxonomy_id, hours=hours, limit=limit, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)

Get Label Distribution

Get label distribution.

Analyzes label usage including:
- Top labels by assignment count
- Label popularity percentages
- Confidence by label

**Use Cases:**
- Understand label usage
- Identify most common categories
- Balance taxonomy coverage

### Example


```python
import mixpeek
from mixpeek.models.label_distribution_response import LabelDistributionResponse
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.AnalyticsApi(api_client)
    taxonomy_id = 'taxonomy_id_example' # str | 
    hours = 168 # int |  (optional) (default to 168)
    limit = 50 # int |  (optional) (default to 50)
    authorization = 'authorization_example' # str | REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. (optional)
    authorization2 = 'authorization_example' # str |  (optional)
    x_namespace = 'x_namespace_example' # str | REQUIRED: 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' (optional)

    try:
        # Get Label Distribution
        api_response = api_instance.get_label_distribution_analytics_taxonomies_taxonomy(taxonomy_id, hours=hours, limit=limit, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)
        print("The response of AnalyticsApi->get_label_distribution_analytics_taxonomies_taxonomy:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AnalyticsApi->get_label_distribution_analytics_taxonomies_taxonomy: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **taxonomy_id** | **str**|  | 
 **hours** | **int**|  | [optional] [default to 168]
 **limit** | **int**|  | [optional] [default to 50]
 **authorization** | **str**| REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. | [optional] 
 **authorization2** | **str**|  | [optional] 
 **x_namespace** | **str**| REQUIRED: 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' | [optional] 

### Return type

[**LabelDistributionResponse**](LabelDistributionResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**400** | Bad Request |  -  |
**401** | Unauthorized |  -  |
**403** | Forbidden |  -  |
**404** | Not Found |  -  |
**422** | Validation Error |  -  |
**500** | Internal Server Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_label_distribution_analytics_taxonomies_taxonomy_0**
> LabelDistributionResponse get_label_distribution_analytics_taxonomies_taxonomy_0(taxonomy_id, hours=hours, limit=limit, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)

Get Label Distribution

Get label distribution.

Analyzes label usage including:
- Top labels by assignment count
- Label popularity percentages
- Confidence by label

**Use Cases:**
- Understand label usage
- Identify most common categories
- Balance taxonomy coverage

### Example


```python
import mixpeek
from mixpeek.models.label_distribution_response import LabelDistributionResponse
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.AnalyticsApi(api_client)
    taxonomy_id = 'taxonomy_id_example' # str | 
    hours = 168 # int |  (optional) (default to 168)
    limit = 50 # int |  (optional) (default to 50)
    authorization = 'authorization_example' # str | REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. (optional)
    authorization2 = 'authorization_example' # str |  (optional)
    x_namespace = 'x_namespace_example' # str | REQUIRED: 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' (optional)

    try:
        # Get Label Distribution
        api_response = api_instance.get_label_distribution_analytics_taxonomies_taxonomy_0(taxonomy_id, hours=hours, limit=limit, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)
        print("The response of AnalyticsApi->get_label_distribution_analytics_taxonomies_taxonomy_0:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AnalyticsApi->get_label_distribution_analytics_taxonomies_taxonomy_0: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **taxonomy_id** | **str**|  | 
 **hours** | **int**|  | [optional] [default to 168]
 **limit** | **int**|  | [optional] [default to 50]
 **authorization** | **str**| REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. | [optional] 
 **authorization2** | **str**|  | [optional] 
 **x_namespace** | **str**| REQUIRED: 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' | [optional] 

### Return type

[**LabelDistributionResponse**](LabelDistributionResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**400** | Bad Request |  -  |
**401** | Unauthorized |  -  |
**403** | Forbidden |  -  |
**404** | Not Found |  -  |
**422** | Validation Error |  -  |
**500** | Internal Server Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_latency_metrics_analytics**
> LatencyResponse get_latency_metrics_analytics(collection_id, hours=hours, group_by=group_by, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)

Get Latency Metrics

Get processing latency distribution.

Analyzes document processing latency including:
- Latency percentiles over time
- Slowest document operations
- Performance trends

### Example


```python
import mixpeek
from mixpeek.models.latency_response import LatencyResponse
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.AnalyticsApi(api_client)
    collection_id = 'collection_id_example' # str | 
    hours = 24 # int |  (optional) (default to 24)
    group_by = 'hour' # str |  (optional) (default to 'hour')
    authorization = 'authorization_example' # str | REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. (optional)
    authorization2 = 'authorization_example' # str |  (optional)
    x_namespace = 'x_namespace_example' # str | REQUIRED: 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' (optional)

    try:
        # Get Latency Metrics
        api_response = api_instance.get_latency_metrics_analytics(collection_id, hours=hours, group_by=group_by, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)
        print("The response of AnalyticsApi->get_latency_metrics_analytics:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AnalyticsApi->get_latency_metrics_analytics: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **collection_id** | **str**|  | 
 **hours** | **int**|  | [optional] [default to 24]
 **group_by** | **str**|  | [optional] [default to 'hour']
 **authorization** | **str**| REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. | [optional] 
 **authorization2** | **str**|  | [optional] 
 **x_namespace** | **str**| REQUIRED: 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' | [optional] 

### Return type

[**LatencyResponse**](LatencyResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**400** | Bad Request |  -  |
**401** | Unauthorized |  -  |
**403** | Forbidden |  -  |
**404** | Not Found |  -  |
**422** | Validation Error |  -  |
**500** | Internal Server Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_latency_metrics_analytics_0**
> LatencyResponse get_latency_metrics_analytics_0(collection_id, hours=hours, group_by=group_by, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)

Get Latency Metrics

Get processing latency distribution.

Analyzes document processing latency including:
- Latency percentiles over time
- Slowest document operations
- Performance trends

### Example


```python
import mixpeek
from mixpeek.models.latency_response import LatencyResponse
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.AnalyticsApi(api_client)
    collection_id = 'collection_id_example' # str | 
    hours = 24 # int |  (optional) (default to 24)
    group_by = 'hour' # str |  (optional) (default to 'hour')
    authorization = 'authorization_example' # str | REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. (optional)
    authorization2 = 'authorization_example' # str |  (optional)
    x_namespace = 'x_namespace_example' # str | REQUIRED: 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' (optional)

    try:
        # Get Latency Metrics
        api_response = api_instance.get_latency_metrics_analytics_0(collection_id, hours=hours, group_by=group_by, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)
        print("The response of AnalyticsApi->get_latency_metrics_analytics_0:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AnalyticsApi->get_latency_metrics_analytics_0: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **collection_id** | **str**|  | 
 **hours** | **int**|  | [optional] [default to 24]
 **group_by** | **str**|  | [optional] [default to 'hour']
 **authorization** | **str**| REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. | [optional] 
 **authorization2** | **str**|  | [optional] 
 **x_namespace** | **str**| REQUIRED: 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' | [optional] 

### Return type

[**LatencyResponse**](LatencyResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**400** | Bad Request |  -  |
**401** | Unauthorized |  -  |
**403** | Forbidden |  -  |
**404** | Not Found |  -  |
**422** | Validation Error |  -  |
**500** | Internal Server Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_most_queried_fields_analytics_namespaces**
> MostQueriedFieldsResponse get_most_queried_fields_analytics_namespaces(days=days, limit=limit, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)

Get Most Queried Fields

Get most frequently queried metadata fields.

Identifies which metadata fields are accessed most often in retriever queries,
helping prioritize index creation and understand query patterns.

**Use Cases:**
- Identify fields that need indexing
- Understand common query patterns
- Prioritize optimization efforts
- Plan database schema improvements

**Response Includes:**
- Field name and usage frequency
- Average and P95 latency metrics
- Total unique fields analyzed

**Example:**
```bash
curl -X GET "https://api.mixpeek.com/v1/analytics/namespaces/fields/most-queried?days=30&limit=20" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "X-Namespace: your-namespace"
```

### Example


```python
import mixpeek
from mixpeek.models.most_queried_fields_response import MostQueriedFieldsResponse
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.AnalyticsApi(api_client)
    days = 30 # int | Days of history to analyze (optional) (default to 30)
    limit = 50 # int | Maximum fields to return (optional) (default to 50)
    authorization = 'authorization_example' # str | REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. (optional)
    authorization2 = 'authorization_example' # str |  (optional)
    x_namespace = 'x_namespace_example' # str | REQUIRED: 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' (optional)

    try:
        # Get Most Queried Fields
        api_response = api_instance.get_most_queried_fields_analytics_namespaces(days=days, limit=limit, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)
        print("The response of AnalyticsApi->get_most_queried_fields_analytics_namespaces:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AnalyticsApi->get_most_queried_fields_analytics_namespaces: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **days** | **int**| Days of history to analyze | [optional] [default to 30]
 **limit** | **int**| Maximum fields to return | [optional] [default to 50]
 **authorization** | **str**| REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. | [optional] 
 **authorization2** | **str**|  | [optional] 
 **x_namespace** | **str**| REQUIRED: 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' | [optional] 

### Return type

[**MostQueriedFieldsResponse**](MostQueriedFieldsResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**400** | Bad Request |  -  |
**401** | Unauthorized |  -  |
**403** | Forbidden |  -  |
**404** | Not Found |  -  |
**422** | Validation Error |  -  |
**500** | Internal Server Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_most_queried_fields_analytics_namespaces_0**
> MostQueriedFieldsResponse get_most_queried_fields_analytics_namespaces_0(days=days, limit=limit, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)

Get Most Queried Fields

Get most frequently queried metadata fields.

Identifies which metadata fields are accessed most often in retriever queries,
helping prioritize index creation and understand query patterns.

**Use Cases:**
- Identify fields that need indexing
- Understand common query patterns
- Prioritize optimization efforts
- Plan database schema improvements

**Response Includes:**
- Field name and usage frequency
- Average and P95 latency metrics
- Total unique fields analyzed

**Example:**
```bash
curl -X GET "https://api.mixpeek.com/v1/analytics/namespaces/fields/most-queried?days=30&limit=20" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "X-Namespace: your-namespace"
```

### Example


```python
import mixpeek
from mixpeek.models.most_queried_fields_response import MostQueriedFieldsResponse
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.AnalyticsApi(api_client)
    days = 30 # int | Days of history to analyze (optional) (default to 30)
    limit = 50 # int | Maximum fields to return (optional) (default to 50)
    authorization = 'authorization_example' # str | REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. (optional)
    authorization2 = 'authorization_example' # str |  (optional)
    x_namespace = 'x_namespace_example' # str | REQUIRED: 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' (optional)

    try:
        # Get Most Queried Fields
        api_response = api_instance.get_most_queried_fields_analytics_namespaces_0(days=days, limit=limit, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)
        print("The response of AnalyticsApi->get_most_queried_fields_analytics_namespaces_0:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AnalyticsApi->get_most_queried_fields_analytics_namespaces_0: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **days** | **int**| Days of history to analyze | [optional] [default to 30]
 **limit** | **int**| Maximum fields to return | [optional] [default to 50]
 **authorization** | **str**| REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. | [optional] 
 **authorization2** | **str**|  | [optional] 
 **x_namespace** | **str**| REQUIRED: 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' | [optional] 

### Return type

[**MostQueriedFieldsResponse**](MostQueriedFieldsResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**400** | Bad Request |  -  |
**401** | Unauthorized |  -  |
**403** | Forbidden |  -  |
**404** | Not Found |  -  |
**422** | Validation Error |  -  |
**500** | Internal Server Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_namespace_summary_analytics**
> NamespaceSummaryResponse get_namespace_summary_analytics(days=days, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)

Get Namespace Summary

Get comprehensive namespace optimization summary.

Provides a complete overview of namespace performance including:
- Top index recommendations
- Most queried fields
- Slowest fields
- Compound index opportunities
- Summary statistics

**Use Cases:**
- Get full optimization picture
- Regular performance reviews
- Database health checks
- Planning optimization work

**Response Includes:**
- Summary statistics (field counts, priority levels)
- Top 10 index recommendations
- Top 10 most queried fields
- Top 10 slowest fields
- Top 10 compound index opportunities

**Recommended Workflow:**
1. Call this endpoint for overview
2. Use specific endpoints for details
3. Implement high-priority recommendations
4. Monitor improvement over time

**Example:**
```bash
curl -X GET "https://api.mixpeek.com/v1/analytics/namespaces/summary?days=30" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "X-Namespace: your-namespace"
```

### Example


```python
import mixpeek
from mixpeek.models.namespace_summary_response import NamespaceSummaryResponse
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.AnalyticsApi(api_client)
    days = 30 # int | Days of history to analyze (optional) (default to 30)
    authorization = 'authorization_example' # str | REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. (optional)
    authorization2 = 'authorization_example' # str |  (optional)
    x_namespace = 'x_namespace_example' # str | REQUIRED: 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' (optional)

    try:
        # Get Namespace Summary
        api_response = api_instance.get_namespace_summary_analytics(days=days, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)
        print("The response of AnalyticsApi->get_namespace_summary_analytics:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AnalyticsApi->get_namespace_summary_analytics: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **days** | **int**| Days of history to analyze | [optional] [default to 30]
 **authorization** | **str**| REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. | [optional] 
 **authorization2** | **str**|  | [optional] 
 **x_namespace** | **str**| REQUIRED: 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' | [optional] 

### Return type

[**NamespaceSummaryResponse**](NamespaceSummaryResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**400** | Bad Request |  -  |
**401** | Unauthorized |  -  |
**403** | Forbidden |  -  |
**404** | Not Found |  -  |
**422** | Validation Error |  -  |
**500** | Internal Server Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_namespace_summary_analytics_0**
> NamespaceSummaryResponse get_namespace_summary_analytics_0(days=days, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)

Get Namespace Summary

Get comprehensive namespace optimization summary.

Provides a complete overview of namespace performance including:
- Top index recommendations
- Most queried fields
- Slowest fields
- Compound index opportunities
- Summary statistics

**Use Cases:**
- Get full optimization picture
- Regular performance reviews
- Database health checks
- Planning optimization work

**Response Includes:**
- Summary statistics (field counts, priority levels)
- Top 10 index recommendations
- Top 10 most queried fields
- Top 10 slowest fields
- Top 10 compound index opportunities

**Recommended Workflow:**
1. Call this endpoint for overview
2. Use specific endpoints for details
3. Implement high-priority recommendations
4. Monitor improvement over time

**Example:**
```bash
curl -X GET "https://api.mixpeek.com/v1/analytics/namespaces/summary?days=30" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "X-Namespace: your-namespace"
```

### Example


```python
import mixpeek
from mixpeek.models.namespace_summary_response import NamespaceSummaryResponse
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.AnalyticsApi(api_client)
    days = 30 # int | Days of history to analyze (optional) (default to 30)
    authorization = 'authorization_example' # str | REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. (optional)
    authorization2 = 'authorization_example' # str |  (optional)
    x_namespace = 'x_namespace_example' # str | REQUIRED: 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' (optional)

    try:
        # Get Namespace Summary
        api_response = api_instance.get_namespace_summary_analytics_0(days=days, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)
        print("The response of AnalyticsApi->get_namespace_summary_analytics_0:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AnalyticsApi->get_namespace_summary_analytics_0: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **days** | **int**| Days of history to analyze | [optional] [default to 30]
 **authorization** | **str**| REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. | [optional] 
 **authorization2** | **str**|  | [optional] 
 **x_namespace** | **str**| REQUIRED: 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' | [optional] 

### Return type

[**NamespaceSummaryResponse**](NamespaceSummaryResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**400** | Bad Request |  -  |
**401** | Unauthorized |  -  |
**403** | Forbidden |  -  |
**404** | Not Found |  -  |
**422** | Validation Error |  -  |
**500** | Internal Server Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_retriever_performance_analytics**
> RetrieverPerformanceResponse get_retriever_performance_analytics(retriever_id, start_date=start_date, end_date=end_date, group_by=group_by, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)

Get Retriever Performance

Get retriever performance metrics for tuning.

Retrieves time-series performance data including:
- Query latency (P50, P95, P99)
- Query counts
- Result counts
- Latency trends

**Use Cases:**
- Monitor retriever performance over time
- Identify performance degradations
- Compare performance across time periods
- Establish performance baselines

**Example:**
```bash
curl -X GET "https://api.mixpeek.com/v1/analytics/retrievers/ret_abc123/performance?hours=24&group_by=hour" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "X-Namespace: your-namespace"
```

### Example


```python
import mixpeek
from mixpeek.models.retriever_performance_response import RetrieverPerformanceResponse
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.AnalyticsApi(api_client)
    retriever_id = 'retriever_id_example' # str | 
    start_date = '2013-10-20T19:20:30+01:00' # datetime | Start date (UTC) (optional)
    end_date = '2013-10-20T19:20:30+01:00' # datetime | End date (UTC) (optional)
    group_by = 'hour' # str | Time grouping: hour, day, week (optional) (default to 'hour')
    authorization = 'authorization_example' # str | REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. (optional)
    authorization2 = 'authorization_example' # str |  (optional)
    x_namespace = 'x_namespace_example' # str | REQUIRED: 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' (optional)

    try:
        # Get Retriever Performance
        api_response = api_instance.get_retriever_performance_analytics(retriever_id, start_date=start_date, end_date=end_date, group_by=group_by, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)
        print("The response of AnalyticsApi->get_retriever_performance_analytics:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AnalyticsApi->get_retriever_performance_analytics: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **retriever_id** | **str**|  | 
 **start_date** | **datetime**| Start date (UTC) | [optional] 
 **end_date** | **datetime**| End date (UTC) | [optional] 
 **group_by** | **str**| Time grouping: hour, day, week | [optional] [default to 'hour']
 **authorization** | **str**| REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. | [optional] 
 **authorization2** | **str**|  | [optional] 
 **x_namespace** | **str**| REQUIRED: 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' | [optional] 

### Return type

[**RetrieverPerformanceResponse**](RetrieverPerformanceResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**400** | Bad Request |  -  |
**401** | Unauthorized |  -  |
**403** | Forbidden |  -  |
**404** | Not Found |  -  |
**422** | Validation Error |  -  |
**500** | Internal Server Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_retriever_performance_analytics_0**
> RetrieverPerformanceResponse get_retriever_performance_analytics_0(retriever_id, start_date=start_date, end_date=end_date, group_by=group_by, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)

Get Retriever Performance

Get retriever performance metrics for tuning.

Retrieves time-series performance data including:
- Query latency (P50, P95, P99)
- Query counts
- Result counts
- Latency trends

**Use Cases:**
- Monitor retriever performance over time
- Identify performance degradations
- Compare performance across time periods
- Establish performance baselines

**Example:**
```bash
curl -X GET "https://api.mixpeek.com/v1/analytics/retrievers/ret_abc123/performance?hours=24&group_by=hour" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "X-Namespace: your-namespace"
```

### Example


```python
import mixpeek
from mixpeek.models.retriever_performance_response import RetrieverPerformanceResponse
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.AnalyticsApi(api_client)
    retriever_id = 'retriever_id_example' # str | 
    start_date = '2013-10-20T19:20:30+01:00' # datetime | Start date (UTC) (optional)
    end_date = '2013-10-20T19:20:30+01:00' # datetime | End date (UTC) (optional)
    group_by = 'hour' # str | Time grouping: hour, day, week (optional) (default to 'hour')
    authorization = 'authorization_example' # str | REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. (optional)
    authorization2 = 'authorization_example' # str |  (optional)
    x_namespace = 'x_namespace_example' # str | REQUIRED: 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' (optional)

    try:
        # Get Retriever Performance
        api_response = api_instance.get_retriever_performance_analytics_0(retriever_id, start_date=start_date, end_date=end_date, group_by=group_by, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)
        print("The response of AnalyticsApi->get_retriever_performance_analytics_0:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AnalyticsApi->get_retriever_performance_analytics_0: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **retriever_id** | **str**|  | 
 **start_date** | **datetime**| Start date (UTC) | [optional] 
 **end_date** | **datetime**| End date (UTC) | [optional] 
 **group_by** | **str**| Time grouping: hour, day, week | [optional] [default to 'hour']
 **authorization** | **str**| REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. | [optional] 
 **authorization2** | **str**|  | [optional] 
 **x_namespace** | **str**| REQUIRED: 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' | [optional] 

### Return type

[**RetrieverPerformanceResponse**](RetrieverPerformanceResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**400** | Bad Request |  -  |
**401** | Unauthorized |  -  |
**403** | Forbidden |  -  |
**404** | Not Found |  -  |
**422** | Validation Error |  -  |
**500** | Internal Server Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_retriever_signals_analytics**
> List[RetrieverSignal] get_retriever_signals_analytics(retriever_id, signal_type=signal_type, limit=limit, hours=hours, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)

Get Retriever Signals

Get retriever signals for interaction tuning.

Retrieves fine-grained signals about retriever behavior:
- Cache hits/misses
- Reranking scores
- Filter effectiveness
- Query expansion results

**Signal Types:**
- `cache_hit`: Successful cache lookups
- `cache_miss`: Cache misses requiring full search
- `rerank_scores`: Reranking effectiveness metrics
- `filter_reduction`: Pre-filter document reduction
- `expansion_results`: Query expansion impact

**Use Cases:**
- Fine-tune retrieval parameters
- Analyze query patterns
- Optimize cache strategies
- Validate optimization improvements

**Example:**
```bash
curl -X GET "https://api.mixpeek.com/v1/analytics/retrievers/ret_abc123/signals?signal_type=rerank_scores&limit=50" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "X-Namespace: your-namespace"
```

### Example


```python
import mixpeek
from mixpeek.models.retriever_signal import RetrieverSignal
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.AnalyticsApi(api_client)
    retriever_id = 'retriever_id_example' # str | 
    signal_type = 'signal_type_example' # str | Filter by signal type (cache_hit, rerank_scores, etc.) (optional)
    limit = 100 # int | Maximum results (optional) (default to 100)
    hours = 24 # int | Hours of history (optional) (default to 24)
    authorization = 'authorization_example' # str | REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. (optional)
    authorization2 = 'authorization_example' # str |  (optional)
    x_namespace = 'x_namespace_example' # str | REQUIRED: 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' (optional)

    try:
        # Get Retriever Signals
        api_response = api_instance.get_retriever_signals_analytics(retriever_id, signal_type=signal_type, limit=limit, hours=hours, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)
        print("The response of AnalyticsApi->get_retriever_signals_analytics:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AnalyticsApi->get_retriever_signals_analytics: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **retriever_id** | **str**|  | 
 **signal_type** | **str**| Filter by signal type (cache_hit, rerank_scores, etc.) | [optional] 
 **limit** | **int**| Maximum results | [optional] [default to 100]
 **hours** | **int**| Hours of history | [optional] [default to 24]
 **authorization** | **str**| REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. | [optional] 
 **authorization2** | **str**|  | [optional] 
 **x_namespace** | **str**| REQUIRED: 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' | [optional] 

### Return type

[**List[RetrieverSignal]**](RetrieverSignal.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**400** | Bad Request |  -  |
**401** | Unauthorized |  -  |
**403** | Forbidden |  -  |
**404** | Not Found |  -  |
**422** | Validation Error |  -  |
**500** | Internal Server Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_retriever_signals_analytics_0**
> List[RetrieverSignal] get_retriever_signals_analytics_0(retriever_id, signal_type=signal_type, limit=limit, hours=hours, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)

Get Retriever Signals

Get retriever signals for interaction tuning.

Retrieves fine-grained signals about retriever behavior:
- Cache hits/misses
- Reranking scores
- Filter effectiveness
- Query expansion results

**Signal Types:**
- `cache_hit`: Successful cache lookups
- `cache_miss`: Cache misses requiring full search
- `rerank_scores`: Reranking effectiveness metrics
- `filter_reduction`: Pre-filter document reduction
- `expansion_results`: Query expansion impact

**Use Cases:**
- Fine-tune retrieval parameters
- Analyze query patterns
- Optimize cache strategies
- Validate optimization improvements

**Example:**
```bash
curl -X GET "https://api.mixpeek.com/v1/analytics/retrievers/ret_abc123/signals?signal_type=rerank_scores&limit=50" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "X-Namespace: your-namespace"
```

### Example


```python
import mixpeek
from mixpeek.models.retriever_signal import RetrieverSignal
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.AnalyticsApi(api_client)
    retriever_id = 'retriever_id_example' # str | 
    signal_type = 'signal_type_example' # str | Filter by signal type (cache_hit, rerank_scores, etc.) (optional)
    limit = 100 # int | Maximum results (optional) (default to 100)
    hours = 24 # int | Hours of history (optional) (default to 24)
    authorization = 'authorization_example' # str | REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. (optional)
    authorization2 = 'authorization_example' # str |  (optional)
    x_namespace = 'x_namespace_example' # str | REQUIRED: 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' (optional)

    try:
        # Get Retriever Signals
        api_response = api_instance.get_retriever_signals_analytics_0(retriever_id, signal_type=signal_type, limit=limit, hours=hours, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)
        print("The response of AnalyticsApi->get_retriever_signals_analytics_0:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AnalyticsApi->get_retriever_signals_analytics_0: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **retriever_id** | **str**|  | 
 **signal_type** | **str**| Filter by signal type (cache_hit, rerank_scores, etc.) | [optional] 
 **limit** | **int**| Maximum results | [optional] [default to 100]
 **hours** | **int**| Hours of history | [optional] [default to 24]
 **authorization** | **str**| REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. | [optional] 
 **authorization2** | **str**|  | [optional] 
 **x_namespace** | **str**| REQUIRED: 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' | [optional] 

### Return type

[**List[RetrieverSignal]**](RetrieverSignal.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**400** | Bad Request |  -  |
**401** | Unauthorized |  -  |
**403** | Forbidden |  -  |
**404** | Not Found |  -  |
**422** | Validation Error |  -  |
**500** | Internal Server Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_slow_queries_analytics_namespaces**
> SlowQueriesResponse get_slow_queries_analytics_namespaces(days=days, latency_threshold_ms=latency_threshold_ms, limit=limit, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)

Get Slow Queries

Get slow queries and their filter patterns.

Identifies queries exceeding a latency threshold and shows which metadata
fields they're filtering on, helping pinpoint optimization opportunities.

**Use Cases:**
- Troubleshoot slow queries
- Identify unindexed fields causing slowdowns
- Debug performance issues
- Optimize query patterns

**Response Includes:**
- Query details (retriever, inputs, latency)
- Results count
- Metadata fields being filtered
- Full query context

**Example:**
```bash
curl -X GET "https://api.mixpeek.com/v1/analytics/namespaces/queries/slow?latency_threshold_ms=1000" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "X-Namespace: your-namespace"
```

### Example


```python
import mixpeek
from mixpeek.models.slow_queries_response import SlowQueriesResponse
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.AnalyticsApi(api_client)
    days = 30 # int | Days of history to analyze (optional) (default to 30)
    latency_threshold_ms = 500 # float | Latency threshold in ms (optional) (default to 500)
    limit = 100 # int | Maximum queries to return (optional) (default to 100)
    authorization = 'authorization_example' # str | REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. (optional)
    authorization2 = 'authorization_example' # str |  (optional)
    x_namespace = 'x_namespace_example' # str | REQUIRED: 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' (optional)

    try:
        # Get Slow Queries
        api_response = api_instance.get_slow_queries_analytics_namespaces(days=days, latency_threshold_ms=latency_threshold_ms, limit=limit, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)
        print("The response of AnalyticsApi->get_slow_queries_analytics_namespaces:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AnalyticsApi->get_slow_queries_analytics_namespaces: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **days** | **int**| Days of history to analyze | [optional] [default to 30]
 **latency_threshold_ms** | **float**| Latency threshold in ms | [optional] [default to 500]
 **limit** | **int**| Maximum queries to return | [optional] [default to 100]
 **authorization** | **str**| REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. | [optional] 
 **authorization2** | **str**|  | [optional] 
 **x_namespace** | **str**| REQUIRED: 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' | [optional] 

### Return type

[**SlowQueriesResponse**](SlowQueriesResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**400** | Bad Request |  -  |
**401** | Unauthorized |  -  |
**403** | Forbidden |  -  |
**404** | Not Found |  -  |
**422** | Validation Error |  -  |
**500** | Internal Server Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_slow_queries_analytics_namespaces_0**
> SlowQueriesResponse get_slow_queries_analytics_namespaces_0(days=days, latency_threshold_ms=latency_threshold_ms, limit=limit, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)

Get Slow Queries

Get slow queries and their filter patterns.

Identifies queries exceeding a latency threshold and shows which metadata
fields they're filtering on, helping pinpoint optimization opportunities.

**Use Cases:**
- Troubleshoot slow queries
- Identify unindexed fields causing slowdowns
- Debug performance issues
- Optimize query patterns

**Response Includes:**
- Query details (retriever, inputs, latency)
- Results count
- Metadata fields being filtered
- Full query context

**Example:**
```bash
curl -X GET "https://api.mixpeek.com/v1/analytics/namespaces/queries/slow?latency_threshold_ms=1000" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "X-Namespace: your-namespace"
```

### Example


```python
import mixpeek
from mixpeek.models.slow_queries_response import SlowQueriesResponse
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.AnalyticsApi(api_client)
    days = 30 # int | Days of history to analyze (optional) (default to 30)
    latency_threshold_ms = 500 # float | Latency threshold in ms (optional) (default to 500)
    limit = 100 # int | Maximum queries to return (optional) (default to 100)
    authorization = 'authorization_example' # str | REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. (optional)
    authorization2 = 'authorization_example' # str |  (optional)
    x_namespace = 'x_namespace_example' # str | REQUIRED: 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' (optional)

    try:
        # Get Slow Queries
        api_response = api_instance.get_slow_queries_analytics_namespaces_0(days=days, latency_threshold_ms=latency_threshold_ms, limit=limit, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)
        print("The response of AnalyticsApi->get_slow_queries_analytics_namespaces_0:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AnalyticsApi->get_slow_queries_analytics_namespaces_0: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **days** | **int**| Days of history to analyze | [optional] [default to 30]
 **latency_threshold_ms** | **float**| Latency threshold in ms | [optional] [default to 500]
 **limit** | **int**| Maximum queries to return | [optional] [default to 100]
 **authorization** | **str**| REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. | [optional] 
 **authorization2** | **str**|  | [optional] 
 **x_namespace** | **str**| REQUIRED: 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' | [optional] 

### Return type

[**SlowQueriesResponse**](SlowQueriesResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**400** | Bad Request |  -  |
**401** | Unauthorized |  -  |
**403** | Forbidden |  -  |
**404** | Not Found |  -  |
**422** | Validation Error |  -  |
**500** | Internal Server Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_slowest_operations_analytics_performance_engine_slow**
> SlowOperationsResponse get_slowest_operations_analytics_performance_engine_slow(hours=hours, limit=limit, threshold_ms=threshold_ms, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)

Get Slowest Operations

Get slowest individual operations.

Returns the slowest profiled operations, useful for debugging
specific slow executions.

**Use Cases:**
- Troubleshoot specific slow operations
- Identify outliers
- Deep dive into problematic executions

**Filtering:**
- `threshold_ms`: Only show operations slower than this
- Default: 1000ms (1 second)

**Response:**
- Timestamp of slow operation
- Stage name and component
- Latency in milliseconds
- Full metadata context

**Example:**
```bash
GET /v1/analytics/performance/engine/slow-operations?hours=24&threshold_ms=5000
```

### Example


```python
import mixpeek
from mixpeek.models.slow_operations_response import SlowOperationsResponse
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.AnalyticsApi(api_client)
    hours = 24 # int | Hours of history (optional) (default to 24)
    limit = 10 # int | Number of operations to return (optional) (default to 10)
    threshold_ms = 1000 # float | Only show operations slower than this (ms) (optional) (default to 1000)
    authorization = 'authorization_example' # str | REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. (optional)
    authorization2 = 'authorization_example' # str |  (optional)
    x_namespace = 'x_namespace_example' # str | REQUIRED: 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' (optional)

    try:
        # Get Slowest Operations
        api_response = api_instance.get_slowest_operations_analytics_performance_engine_slow(hours=hours, limit=limit, threshold_ms=threshold_ms, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)
        print("The response of AnalyticsApi->get_slowest_operations_analytics_performance_engine_slow:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AnalyticsApi->get_slowest_operations_analytics_performance_engine_slow: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **hours** | **int**| Hours of history | [optional] [default to 24]
 **limit** | **int**| Number of operations to return | [optional] [default to 10]
 **threshold_ms** | **float**| Only show operations slower than this (ms) | [optional] [default to 1000]
 **authorization** | **str**| REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. | [optional] 
 **authorization2** | **str**|  | [optional] 
 **x_namespace** | **str**| REQUIRED: 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' | [optional] 

### Return type

[**SlowOperationsResponse**](SlowOperationsResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**400** | Bad Request |  -  |
**401** | Unauthorized |  -  |
**403** | Forbidden |  -  |
**404** | Not Found |  -  |
**422** | Validation Error |  -  |
**500** | Internal Server Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_slowest_operations_analytics_performance_engine_slow_0**
> SlowOperationsResponse get_slowest_operations_analytics_performance_engine_slow_0(hours=hours, limit=limit, threshold_ms=threshold_ms, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)

Get Slowest Operations

Get slowest individual operations.

Returns the slowest profiled operations, useful for debugging
specific slow executions.

**Use Cases:**
- Troubleshoot specific slow operations
- Identify outliers
- Deep dive into problematic executions

**Filtering:**
- `threshold_ms`: Only show operations slower than this
- Default: 1000ms (1 second)

**Response:**
- Timestamp of slow operation
- Stage name and component
- Latency in milliseconds
- Full metadata context

**Example:**
```bash
GET /v1/analytics/performance/engine/slow-operations?hours=24&threshold_ms=5000
```

### Example


```python
import mixpeek
from mixpeek.models.slow_operations_response import SlowOperationsResponse
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.AnalyticsApi(api_client)
    hours = 24 # int | Hours of history (optional) (default to 24)
    limit = 10 # int | Number of operations to return (optional) (default to 10)
    threshold_ms = 1000 # float | Only show operations slower than this (ms) (optional) (default to 1000)
    authorization = 'authorization_example' # str | REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. (optional)
    authorization2 = 'authorization_example' # str |  (optional)
    x_namespace = 'x_namespace_example' # str | REQUIRED: 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' (optional)

    try:
        # Get Slowest Operations
        api_response = api_instance.get_slowest_operations_analytics_performance_engine_slow_0(hours=hours, limit=limit, threshold_ms=threshold_ms, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)
        print("The response of AnalyticsApi->get_slowest_operations_analytics_performance_engine_slow_0:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AnalyticsApi->get_slowest_operations_analytics_performance_engine_slow_0: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **hours** | **int**| Hours of history | [optional] [default to 24]
 **limit** | **int**| Number of operations to return | [optional] [default to 10]
 **threshold_ms** | **float**| Only show operations slower than this (ms) | [optional] [default to 1000]
 **authorization** | **str**| REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. | [optional] 
 **authorization2** | **str**|  | [optional] 
 **x_namespace** | **str**| REQUIRED: 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' | [optional] 

### Return type

[**SlowOperationsResponse**](SlowOperationsResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**400** | Bad Request |  -  |
**401** | Unauthorized |  -  |
**403** | Forbidden |  -  |
**404** | Not Found |  -  |
**422** | Validation Error |  -  |
**500** | Internal Server Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_slowest_queries_analytics_retrievers_id_slow**
> List[Dict[str, object]] get_slowest_queries_analytics_retrievers_id_slow(retriever_id, limit=limit, hours=hours, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)

Get Slowest Queries

Get slowest queries for troubleshooting.

Identifies slowest-performing queries for optimization:
- Query text
- Execution time
- Result counts
- Stage breakdown

**Use Cases:**
- Identify problematic queries
- Debug performance issues
- Optimize query patterns
- User experience improvements

**Example:**
```bash
curl -X GET "https://api.mixpeek.com/v1/analytics/retrievers/ret_abc123/slow-queries?limit=10&hours=24" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "X-Namespace: your-namespace"
```

### Example


```python
import mixpeek
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.AnalyticsApi(api_client)
    retriever_id = 'retriever_id_example' # str | 
    limit = 10 # int | Number of queries to return (optional) (default to 10)
    hours = 24 # int | Hours of history (optional) (default to 24)
    authorization = 'authorization_example' # str | REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. (optional)
    authorization2 = 'authorization_example' # str |  (optional)
    x_namespace = 'x_namespace_example' # str | REQUIRED: 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' (optional)

    try:
        # Get Slowest Queries
        api_response = api_instance.get_slowest_queries_analytics_retrievers_id_slow(retriever_id, limit=limit, hours=hours, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)
        print("The response of AnalyticsApi->get_slowest_queries_analytics_retrievers_id_slow:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AnalyticsApi->get_slowest_queries_analytics_retrievers_id_slow: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **retriever_id** | **str**|  | 
 **limit** | **int**| Number of queries to return | [optional] [default to 10]
 **hours** | **int**| Hours of history | [optional] [default to 24]
 **authorization** | **str**| REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. | [optional] 
 **authorization2** | **str**|  | [optional] 
 **x_namespace** | **str**| REQUIRED: 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' | [optional] 

### Return type

**List[Dict[str, object]]**

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**400** | Bad Request |  -  |
**401** | Unauthorized |  -  |
**403** | Forbidden |  -  |
**404** | Not Found |  -  |
**422** | Validation Error |  -  |
**500** | Internal Server Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_slowest_queries_analytics_retrievers_id_slow_0**
> List[Dict[str, object]] get_slowest_queries_analytics_retrievers_id_slow_0(retriever_id, limit=limit, hours=hours, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)

Get Slowest Queries

Get slowest queries for troubleshooting.

Identifies slowest-performing queries for optimization:
- Query text
- Execution time
- Result counts
- Stage breakdown

**Use Cases:**
- Identify problematic queries
- Debug performance issues
- Optimize query patterns
- User experience improvements

**Example:**
```bash
curl -X GET "https://api.mixpeek.com/v1/analytics/retrievers/ret_abc123/slow-queries?limit=10&hours=24" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "X-Namespace: your-namespace"
```

### Example


```python
import mixpeek
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.AnalyticsApi(api_client)
    retriever_id = 'retriever_id_example' # str | 
    limit = 10 # int | Number of queries to return (optional) (default to 10)
    hours = 24 # int | Hours of history (optional) (default to 24)
    authorization = 'authorization_example' # str | REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. (optional)
    authorization2 = 'authorization_example' # str |  (optional)
    x_namespace = 'x_namespace_example' # str | REQUIRED: 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' (optional)

    try:
        # Get Slowest Queries
        api_response = api_instance.get_slowest_queries_analytics_retrievers_id_slow_0(retriever_id, limit=limit, hours=hours, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)
        print("The response of AnalyticsApi->get_slowest_queries_analytics_retrievers_id_slow_0:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AnalyticsApi->get_slowest_queries_analytics_retrievers_id_slow_0: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **retriever_id** | **str**|  | 
 **limit** | **int**| Number of queries to return | [optional] [default to 10]
 **hours** | **int**| Hours of history | [optional] [default to 24]
 **authorization** | **str**| REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. | [optional] 
 **authorization2** | **str**|  | [optional] 
 **x_namespace** | **str**| REQUIRED: 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' | [optional] 

### Return type

**List[Dict[str, object]]**

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**400** | Bad Request |  -  |
**401** | Unauthorized |  -  |
**403** | Forbidden |  -  |
**404** | Not Found |  -  |
**422** | Validation Error |  -  |
**500** | Internal Server Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_stage_breakdown_analytics_retrievers**
> StageBreakdownResponse get_stage_breakdown_analytics_retrievers(retriever_id, hours=hours, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)

Get Stage Breakdown

Get stage-level performance breakdown.

Analyzes individual stage performance to identify bottlenecks:
- Stage execution times
- Document flow (in/out)
- Stage-level latency distribution

**Use Cases:**
- Identify slow stages in retrieval pipeline
- Optimize stage ordering
- Debug pipeline bottlenecks
- Understand document reduction rates

**Example:**
```bash
curl -X GET "https://api.mixpeek.com/v1/analytics/retrievers/ret_abc123/stages?hours=24" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "X-Namespace: your-namespace"
```

### Example


```python
import mixpeek
from mixpeek.models.stage_breakdown_response import StageBreakdownResponse
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.AnalyticsApi(api_client)
    retriever_id = 'retriever_id_example' # str | 
    hours = 24 # int | Hours of history (optional) (default to 24)
    authorization = 'authorization_example' # str | REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. (optional)
    authorization2 = 'authorization_example' # str |  (optional)
    x_namespace = 'x_namespace_example' # str | REQUIRED: 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' (optional)

    try:
        # Get Stage Breakdown
        api_response = api_instance.get_stage_breakdown_analytics_retrievers(retriever_id, hours=hours, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)
        print("The response of AnalyticsApi->get_stage_breakdown_analytics_retrievers:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AnalyticsApi->get_stage_breakdown_analytics_retrievers: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **retriever_id** | **str**|  | 
 **hours** | **int**| Hours of history | [optional] [default to 24]
 **authorization** | **str**| REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. | [optional] 
 **authorization2** | **str**|  | [optional] 
 **x_namespace** | **str**| REQUIRED: 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' | [optional] 

### Return type

[**StageBreakdownResponse**](StageBreakdownResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**400** | Bad Request |  -  |
**401** | Unauthorized |  -  |
**403** | Forbidden |  -  |
**404** | Not Found |  -  |
**422** | Validation Error |  -  |
**500** | Internal Server Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_stage_breakdown_analytics_retrievers_0**
> StageBreakdownResponse get_stage_breakdown_analytics_retrievers_0(retriever_id, hours=hours, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)

Get Stage Breakdown

Get stage-level performance breakdown.

Analyzes individual stage performance to identify bottlenecks:
- Stage execution times
- Document flow (in/out)
- Stage-level latency distribution

**Use Cases:**
- Identify slow stages in retrieval pipeline
- Optimize stage ordering
- Debug pipeline bottlenecks
- Understand document reduction rates

**Example:**
```bash
curl -X GET "https://api.mixpeek.com/v1/analytics/retrievers/ret_abc123/stages?hours=24" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "X-Namespace: your-namespace"
```

### Example


```python
import mixpeek
from mixpeek.models.stage_breakdown_response import StageBreakdownResponse
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.AnalyticsApi(api_client)
    retriever_id = 'retriever_id_example' # str | 
    hours = 24 # int | Hours of history (optional) (default to 24)
    authorization = 'authorization_example' # str | REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. (optional)
    authorization2 = 'authorization_example' # str |  (optional)
    x_namespace = 'x_namespace_example' # str | REQUIRED: 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' (optional)

    try:
        # Get Stage Breakdown
        api_response = api_instance.get_stage_breakdown_analytics_retrievers_0(retriever_id, hours=hours, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)
        print("The response of AnalyticsApi->get_stage_breakdown_analytics_retrievers_0:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AnalyticsApi->get_stage_breakdown_analytics_retrievers_0: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **retriever_id** | **str**|  | 
 **hours** | **int**| Hours of history | [optional] [default to 24]
 **authorization** | **str**| REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. | [optional] 
 **authorization2** | **str**|  | [optional] 
 **x_namespace** | **str**| REQUIRED: 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' | [optional] 

### Return type

[**StageBreakdownResponse**](StageBreakdownResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**400** | Bad Request |  -  |
**401** | Unauthorized |  -  |
**403** | Forbidden |  -  |
**404** | Not Found |  -  |
**422** | Validation Error |  -  |
**500** | Internal Server Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_sync_comparison_analytics_buckets**
> SyncComparisonResponse get_sync_comparison_analytics_buckets(bucket_id, hours=hours, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)

Get Sync Comparison

Compare performance across sync configurations.

Compares sync configurations by:
- Average duration and throughput
- Success rates
- Total files and bytes synced
- Provider performance

**Use Cases:**
- Compare sync providers (S3 vs GCS)
- Optimize sync configurations
- Identify best-performing syncs
- Benchmark sync strategies

**Example:**
```bash
curl -X GET "https://api.mixpeek.com/v1/analytics/buckets/bkt_abc123/sync-comparison?hours=168" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "X-Namespace: your-namespace"
```

### Example


```python
import mixpeek
from mixpeek.models.sync_comparison_response import SyncComparisonResponse
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.AnalyticsApi(api_client)
    bucket_id = 'bucket_id_example' # str | 
    hours = 168 # int | Hours of history (default: 7 days) (optional) (default to 168)
    authorization = 'authorization_example' # str | REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. (optional)
    authorization2 = 'authorization_example' # str |  (optional)
    x_namespace = 'x_namespace_example' # str | REQUIRED: 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' (optional)

    try:
        # Get Sync Comparison
        api_response = api_instance.get_sync_comparison_analytics_buckets(bucket_id, hours=hours, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)
        print("The response of AnalyticsApi->get_sync_comparison_analytics_buckets:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AnalyticsApi->get_sync_comparison_analytics_buckets: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **bucket_id** | **str**|  | 
 **hours** | **int**| Hours of history (default: 7 days) | [optional] [default to 168]
 **authorization** | **str**| REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. | [optional] 
 **authorization2** | **str**|  | [optional] 
 **x_namespace** | **str**| REQUIRED: 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' | [optional] 

### Return type

[**SyncComparisonResponse**](SyncComparisonResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**400** | Bad Request |  -  |
**401** | Unauthorized |  -  |
**403** | Forbidden |  -  |
**404** | Not Found |  -  |
**422** | Validation Error |  -  |
**500** | Internal Server Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_sync_comparison_analytics_buckets_0**
> SyncComparisonResponse get_sync_comparison_analytics_buckets_0(bucket_id, hours=hours, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)

Get Sync Comparison

Compare performance across sync configurations.

Compares sync configurations by:
- Average duration and throughput
- Success rates
- Total files and bytes synced
- Provider performance

**Use Cases:**
- Compare sync providers (S3 vs GCS)
- Optimize sync configurations
- Identify best-performing syncs
- Benchmark sync strategies

**Example:**
```bash
curl -X GET "https://api.mixpeek.com/v1/analytics/buckets/bkt_abc123/sync-comparison?hours=168" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "X-Namespace: your-namespace"
```

### Example


```python
import mixpeek
from mixpeek.models.sync_comparison_response import SyncComparisonResponse
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.AnalyticsApi(api_client)
    bucket_id = 'bucket_id_example' # str | 
    hours = 168 # int | Hours of history (default: 7 days) (optional) (default to 168)
    authorization = 'authorization_example' # str | REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. (optional)
    authorization2 = 'authorization_example' # str |  (optional)
    x_namespace = 'x_namespace_example' # str | REQUIRED: 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' (optional)

    try:
        # Get Sync Comparison
        api_response = api_instance.get_sync_comparison_analytics_buckets_0(bucket_id, hours=hours, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)
        print("The response of AnalyticsApi->get_sync_comparison_analytics_buckets_0:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AnalyticsApi->get_sync_comparison_analytics_buckets_0: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **bucket_id** | **str**|  | 
 **hours** | **int**| Hours of history (default: 7 days) | [optional] [default to 168]
 **authorization** | **str**| REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. | [optional] 
 **authorization2** | **str**|  | [optional] 
 **x_namespace** | **str**| REQUIRED: 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' | [optional] 

### Return type

[**SyncComparisonResponse**](SyncComparisonResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**400** | Bad Request |  -  |
**401** | Unauthorized |  -  |
**403** | Forbidden |  -  |
**404** | Not Found |  -  |
**422** | Validation Error |  -  |
**500** | Internal Server Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_sync_performance_analytics_buckets**
> SyncPerformanceResponse get_sync_performance_analytics_buckets(bucket_id, sync_config_id=sync_config_id, hours=hours, limit=limit, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)

Get Sync Performance

Get sync performance metrics.

Analyzes sync job execution including:
- Files synced/failed
- Sync duration and throughput
- Success rates by provider

**Use Cases:**
- Monitor sync reliability
- Compare sync configurations
- Identify slow syncs
- Debug sync failures

**Example:**
```bash
curl -X GET "https://api.mixpeek.com/v1/analytics/buckets/bkt_abc123/sync-performance?hours=168" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "X-Namespace: your-namespace"
```

### Example


```python
import mixpeek
from mixpeek.models.sync_performance_response import SyncPerformanceResponse
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.AnalyticsApi(api_client)
    bucket_id = 'bucket_id_example' # str | 
    sync_config_id = 'sync_config_id_example' # str | Filter by sync config ID (optional)
    hours = 168 # int | Hours of history (default: 7 days) (optional) (default to 168)
    limit = 100 # int | Maximum sync runs to return (optional) (default to 100)
    authorization = 'authorization_example' # str | REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. (optional)
    authorization2 = 'authorization_example' # str |  (optional)
    x_namespace = 'x_namespace_example' # str | REQUIRED: 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' (optional)

    try:
        # Get Sync Performance
        api_response = api_instance.get_sync_performance_analytics_buckets(bucket_id, sync_config_id=sync_config_id, hours=hours, limit=limit, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)
        print("The response of AnalyticsApi->get_sync_performance_analytics_buckets:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AnalyticsApi->get_sync_performance_analytics_buckets: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **bucket_id** | **str**|  | 
 **sync_config_id** | **str**| Filter by sync config ID | [optional] 
 **hours** | **int**| Hours of history (default: 7 days) | [optional] [default to 168]
 **limit** | **int**| Maximum sync runs to return | [optional] [default to 100]
 **authorization** | **str**| REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. | [optional] 
 **authorization2** | **str**|  | [optional] 
 **x_namespace** | **str**| REQUIRED: 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' | [optional] 

### Return type

[**SyncPerformanceResponse**](SyncPerformanceResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**400** | Bad Request |  -  |
**401** | Unauthorized |  -  |
**403** | Forbidden |  -  |
**404** | Not Found |  -  |
**422** | Validation Error |  -  |
**500** | Internal Server Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_sync_performance_analytics_buckets_0**
> SyncPerformanceResponse get_sync_performance_analytics_buckets_0(bucket_id, sync_config_id=sync_config_id, hours=hours, limit=limit, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)

Get Sync Performance

Get sync performance metrics.

Analyzes sync job execution including:
- Files synced/failed
- Sync duration and throughput
- Success rates by provider

**Use Cases:**
- Monitor sync reliability
- Compare sync configurations
- Identify slow syncs
- Debug sync failures

**Example:**
```bash
curl -X GET "https://api.mixpeek.com/v1/analytics/buckets/bkt_abc123/sync-performance?hours=168" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "X-Namespace: your-namespace"
```

### Example


```python
import mixpeek
from mixpeek.models.sync_performance_response import SyncPerformanceResponse
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.AnalyticsApi(api_client)
    bucket_id = 'bucket_id_example' # str | 
    sync_config_id = 'sync_config_id_example' # str | Filter by sync config ID (optional)
    hours = 168 # int | Hours of history (default: 7 days) (optional) (default to 168)
    limit = 100 # int | Maximum sync runs to return (optional) (default to 100)
    authorization = 'authorization_example' # str | REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. (optional)
    authorization2 = 'authorization_example' # str |  (optional)
    x_namespace = 'x_namespace_example' # str | REQUIRED: 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' (optional)

    try:
        # Get Sync Performance
        api_response = api_instance.get_sync_performance_analytics_buckets_0(bucket_id, sync_config_id=sync_config_id, hours=hours, limit=limit, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)
        print("The response of AnalyticsApi->get_sync_performance_analytics_buckets_0:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AnalyticsApi->get_sync_performance_analytics_buckets_0: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **bucket_id** | **str**|  | 
 **sync_config_id** | **str**| Filter by sync config ID | [optional] 
 **hours** | **int**| Hours of history (default: 7 days) | [optional] [default to 168]
 **limit** | **int**| Maximum sync runs to return | [optional] [default to 100]
 **authorization** | **str**| REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. | [optional] 
 **authorization2** | **str**|  | [optional] 
 **x_namespace** | **str**| REQUIRED: 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' | [optional] 

### Return type

[**SyncPerformanceResponse**](SyncPerformanceResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**400** | Bad Request |  -  |
**401** | Unauthorized |  -  |
**403** | Forbidden |  -  |
**404** | Not Found |  -  |
**422** | Validation Error |  -  |
**500** | Internal Server Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_upload_performance_analytics_buckets**
> UploadPerformanceResponse get_upload_performance_analytics_buckets(bucket_id, hours=hours, group_by=group_by, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)

Get Upload Performance

Get upload performance metrics.

Analyzes upload operations including:
- Upload latency (P50, P95, P99)
- Throughput (MB/s)
- Error rates

**Use Cases:**
- Monitor upload performance
- Identify performance degradations
- Optimize upload strategies
- Debug upload issues

**Example:**
```bash
curl -X GET "https://api.mixpeek.com/v1/analytics/buckets/bkt_abc123/upload-performance?hours=24" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "X-Namespace: your-namespace"
```

### Example


```python
import mixpeek
from mixpeek.models.upload_performance_response import UploadPerformanceResponse
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.AnalyticsApi(api_client)
    bucket_id = 'bucket_id_example' # str | 
    hours = 24 # int | Hours of history (optional) (default to 24)
    group_by = 'hour' # str | Time grouping: hour, day (optional) (default to 'hour')
    authorization = 'authorization_example' # str | REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. (optional)
    authorization2 = 'authorization_example' # str |  (optional)
    x_namespace = 'x_namespace_example' # str | REQUIRED: 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' (optional)

    try:
        # Get Upload Performance
        api_response = api_instance.get_upload_performance_analytics_buckets(bucket_id, hours=hours, group_by=group_by, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)
        print("The response of AnalyticsApi->get_upload_performance_analytics_buckets:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AnalyticsApi->get_upload_performance_analytics_buckets: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **bucket_id** | **str**|  | 
 **hours** | **int**| Hours of history | [optional] [default to 24]
 **group_by** | **str**| Time grouping: hour, day | [optional] [default to 'hour']
 **authorization** | **str**| REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. | [optional] 
 **authorization2** | **str**|  | [optional] 
 **x_namespace** | **str**| REQUIRED: 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' | [optional] 

### Return type

[**UploadPerformanceResponse**](UploadPerformanceResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**400** | Bad Request |  -  |
**401** | Unauthorized |  -  |
**403** | Forbidden |  -  |
**404** | Not Found |  -  |
**422** | Validation Error |  -  |
**500** | Internal Server Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_upload_performance_analytics_buckets_0**
> UploadPerformanceResponse get_upload_performance_analytics_buckets_0(bucket_id, hours=hours, group_by=group_by, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)

Get Upload Performance

Get upload performance metrics.

Analyzes upload operations including:
- Upload latency (P50, P95, P99)
- Throughput (MB/s)
- Error rates

**Use Cases:**
- Monitor upload performance
- Identify performance degradations
- Optimize upload strategies
- Debug upload issues

**Example:**
```bash
curl -X GET "https://api.mixpeek.com/v1/analytics/buckets/bkt_abc123/upload-performance?hours=24" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "X-Namespace: your-namespace"
```

### Example


```python
import mixpeek
from mixpeek.models.upload_performance_response import UploadPerformanceResponse
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.AnalyticsApi(api_client)
    bucket_id = 'bucket_id_example' # str | 
    hours = 24 # int | Hours of history (optional) (default to 24)
    group_by = 'hour' # str | Time grouping: hour, day (optional) (default to 'hour')
    authorization = 'authorization_example' # str | REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. (optional)
    authorization2 = 'authorization_example' # str |  (optional)
    x_namespace = 'x_namespace_example' # str | REQUIRED: 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' (optional)

    try:
        # Get Upload Performance
        api_response = api_instance.get_upload_performance_analytics_buckets_0(bucket_id, hours=hours, group_by=group_by, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)
        print("The response of AnalyticsApi->get_upload_performance_analytics_buckets_0:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AnalyticsApi->get_upload_performance_analytics_buckets_0: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **bucket_id** | **str**|  | 
 **hours** | **int**| Hours of history | [optional] [default to 24]
 **group_by** | **str**| Time grouping: hour, day | [optional] [default to 'hour']
 **authorization** | **str**| REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. | [optional] 
 **authorization2** | **str**|  | [optional] 
 **x_namespace** | **str**| REQUIRED: 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' | [optional] 

### Return type

[**UploadPerformanceResponse**](UploadPerformanceResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**400** | Bad Request |  -  |
**401** | Unauthorized |  -  |
**403** | Forbidden |  -  |
**404** | Not Found |  -  |
**422** | Validation Error |  -  |
**500** | Internal Server Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_usage_summary_analytics**
> Dict[str, object] get_usage_summary_analytics(start_date=start_date, end_date=end_date, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)

Get Usage Summary

Get usage summary for billing.

Returns usage statistics for the namespace including:
- Total API requests
- Compute usage (seconds)
- Storage usage (bytes)
- Total cost

**Time Range:**
- If both `start_date` and `end_date` are provided, uses that range
- If neither provided, defaults to last 30 days
- If only one provided, defaults to now as the other bound

**Example:**
```bash
GET /v1/analytics/usage/summary
GET /v1/analytics/usage/summary?start_date=2025-01-01T00:00:00Z&end_date=2025-01-31T23:59:59Z
```

### Example


```python
import mixpeek
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.AnalyticsApi(api_client)
    start_date = '2013-10-20T19:20:30+01:00' # datetime | Start date (UTC) (optional)
    end_date = '2013-10-20T19:20:30+01:00' # datetime | End date (UTC) (optional)
    authorization = 'authorization_example' # str | REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. (optional)
    authorization2 = 'authorization_example' # str |  (optional)
    x_namespace = 'x_namespace_example' # str | REQUIRED: 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' (optional)

    try:
        # Get Usage Summary
        api_response = api_instance.get_usage_summary_analytics(start_date=start_date, end_date=end_date, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)
        print("The response of AnalyticsApi->get_usage_summary_analytics:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AnalyticsApi->get_usage_summary_analytics: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **start_date** | **datetime**| Start date (UTC) | [optional] 
 **end_date** | **datetime**| End date (UTC) | [optional] 
 **authorization** | **str**| REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. | [optional] 
 **authorization2** | **str**|  | [optional] 
 **x_namespace** | **str**| REQUIRED: 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' | [optional] 

### Return type

**Dict[str, object]**

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**400** | Bad Request |  -  |
**401** | Unauthorized |  -  |
**403** | Forbidden |  -  |
**404** | Not Found |  -  |
**422** | Validation Error |  -  |
**500** | Internal Server Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_usage_summary_analytics_0**
> Dict[str, object] get_usage_summary_analytics_0(start_date=start_date, end_date=end_date, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)

Get Usage Summary

Get usage summary for billing.

Returns usage statistics for the namespace including:
- Total API requests
- Compute usage (seconds)
- Storage usage (bytes)
- Total cost

**Time Range:**
- If both `start_date` and `end_date` are provided, uses that range
- If neither provided, defaults to last 30 days
- If only one provided, defaults to now as the other bound

**Example:**
```bash
GET /v1/analytics/usage/summary
GET /v1/analytics/usage/summary?start_date=2025-01-01T00:00:00Z&end_date=2025-01-31T23:59:59Z
```

### Example


```python
import mixpeek
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.AnalyticsApi(api_client)
    start_date = '2013-10-20T19:20:30+01:00' # datetime | Start date (UTC) (optional)
    end_date = '2013-10-20T19:20:30+01:00' # datetime | End date (UTC) (optional)
    authorization = 'authorization_example' # str | REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. (optional)
    authorization2 = 'authorization_example' # str |  (optional)
    x_namespace = 'x_namespace_example' # str | REQUIRED: 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' (optional)

    try:
        # Get Usage Summary
        api_response = api_instance.get_usage_summary_analytics_0(start_date=start_date, end_date=end_date, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)
        print("The response of AnalyticsApi->get_usage_summary_analytics_0:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AnalyticsApi->get_usage_summary_analytics_0: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **start_date** | **datetime**| Start date (UTC) | [optional] 
 **end_date** | **datetime**| End date (UTC) | [optional] 
 **authorization** | **str**| REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. | [optional] 
 **authorization2** | **str**|  | [optional] 
 **x_namespace** | **str**| REQUIRED: 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' | [optional] 

### Return type

**Dict[str, object]**

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**400** | Bad Request |  -  |
**401** | Unauthorized |  -  |
**403** | Forbidden |  -  |
**404** | Not Found |  -  |
**422** | Validation Error |  -  |
**500** | Internal Server Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)