curl --request GET \
--url https://api.mixpeek.com/v1/namespaces/migrations/{migration_id} \
--header 'Authorization: <authorization>'{
"migration_id": "<string>",
"internal_id": "<string>",
"namespace_id": "<string>",
"config": {
"migration_type": "re_extract",
"source_namespace_id": "<string>",
"target_namespace_id": "<string>",
"target_namespace_name": "<string>",
"feature_extractors": [
{
"feature_extractor_name": "<string>",
"version": "<string>",
"parameters": {}
}
],
"filters": {
"collection_ids": [
"<string>"
],
"taxonomy_ids": [
"<string>"
],
"cluster_ids": [
"<string>"
],
"retriever_ids": [
"<string>"
],
"date_range": {},
"auto_include_dependencies": true
},
"batch_options": {
"batch_size": 100,
"max_workers": 10,
"retry_failed": true
},
"taxonomy_options": {
"preserve_taxonomy_ids": true,
"preserve_enrichment_fields": true,
"re_run_enrichment": false,
"migrate_reference_collections": true
},
"cluster_options": {
"preserve_cluster_ids": true,
"preserve_assignments": true,
"migrate_artifacts": true,
"preserve_centroids": true,
"recompute_clusters": false
},
"retriever_options": {
"preserve_retriever_ids": false,
"migrate_interactions": false,
"migrate_execution_history": false,
"validate_references": true
},
"preserve_resource_ids": false,
"dry_run": false,
"webhook_url": "<string>"
},
"status": "draft",
"progress": {
"overall_status": "draft",
"overall_progress_percent": 0,
"current_stage": "namespace_setup",
"stages": [
{
"stage": "namespace_setup",
"status": "draft",
"started_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"progress_percent": 0,
"items_total": 0,
"items_completed": 0,
"items_failed": 0,
"error_message": "<string>"
}
],
"resources": [
{
"resource_id": "<string>",
"resource_type": "bucket",
"status": "draft",
"progress_percent": 0,
"error_message": "<string>"
}
],
"started_at": "2023-11-07T05:31:56Z",
"estimated_completion": "2023-11-07T05:31:56Z"
},
"created_at": "2023-11-07T05:31:56Z",
"validation_result": {
"valid": true,
"errors": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
],
"warnings": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
],
"estimated_resources": {},
"estimated_duration_seconds": 123
},
"dependency_graph": {
"nodes": [
{
"resource_id": "<string>",
"resource_type": "bucket",
"dependencies": [
"<string>"
],
"tier": 0
}
],
"execution_order": [
"<string>"
]
},
"task_id": "<string>",
"started_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"error_message": "<string>",
"additional_data": {}
}Get migration details and status.
Args: request: FastAPI request migration_id: Migration ID
Returns: GetMigrationResponse with full migration details
curl --request GET \
--url https://api.mixpeek.com/v1/namespaces/migrations/{migration_id} \
--header 'Authorization: <authorization>'{
"migration_id": "<string>",
"internal_id": "<string>",
"namespace_id": "<string>",
"config": {
"migration_type": "re_extract",
"source_namespace_id": "<string>",
"target_namespace_id": "<string>",
"target_namespace_name": "<string>",
"feature_extractors": [
{
"feature_extractor_name": "<string>",
"version": "<string>",
"parameters": {}
}
],
"filters": {
"collection_ids": [
"<string>"
],
"taxonomy_ids": [
"<string>"
],
"cluster_ids": [
"<string>"
],
"retriever_ids": [
"<string>"
],
"date_range": {},
"auto_include_dependencies": true
},
"batch_options": {
"batch_size": 100,
"max_workers": 10,
"retry_failed": true
},
"taxonomy_options": {
"preserve_taxonomy_ids": true,
"preserve_enrichment_fields": true,
"re_run_enrichment": false,
"migrate_reference_collections": true
},
"cluster_options": {
"preserve_cluster_ids": true,
"preserve_assignments": true,
"migrate_artifacts": true,
"preserve_centroids": true,
"recompute_clusters": false
},
"retriever_options": {
"preserve_retriever_ids": false,
"migrate_interactions": false,
"migrate_execution_history": false,
"validate_references": true
},
"preserve_resource_ids": false,
"dry_run": false,
"webhook_url": "<string>"
},
"status": "draft",
"progress": {
"overall_status": "draft",
"overall_progress_percent": 0,
"current_stage": "namespace_setup",
"stages": [
{
"stage": "namespace_setup",
"status": "draft",
"started_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"progress_percent": 0,
"items_total": 0,
"items_completed": 0,
"items_failed": 0,
"error_message": "<string>"
}
],
"resources": [
{
"resource_id": "<string>",
"resource_type": "bucket",
"status": "draft",
"progress_percent": 0,
"error_message": "<string>"
}
],
"started_at": "2023-11-07T05:31:56Z",
"estimated_completion": "2023-11-07T05:31:56Z"
},
"created_at": "2023-11-07T05:31:56Z",
"validation_result": {
"valid": true,
"errors": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
],
"warnings": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
],
"estimated_resources": {},
"estimated_duration_seconds": 123
},
"dependency_graph": {
"nodes": [
{
"resource_id": "<string>",
"resource_type": "bucket",
"dependencies": [
"<string>"
],
"tier": 0
}
],
"execution_order": [
"<string>"
]
},
"task_id": "<string>",
"started_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"error_message": "<string>",
"additional_data": {}
}REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings.
Successful Response
Response for getting migration details.
Migration ID
Organization internal ID
Source namespace ID
Migration configuration
Show child attributes
Type of migration to perform
re_extract, copy Source namespace ID
Target namespace ID (auto-generated if not provided)
Name for target namespace
Resource selection filters
Show child attributes
Specific collection IDs to migrate
Specific taxonomy IDs to migrate
Specific cluster IDs to migrate
Specific retriever IDs to migrate
Automatically include required dependencies
Batch processing options
Taxonomy migration options
Show child attributes
Keep same taxonomy IDs in target
Keep taxonomy* fields in documents
Re-run taxonomy enrichment after migration
Automatically migrate reference collections
Cluster migration options
Show child attributes
Keep same cluster IDs in target
Keep cluster_id in documents
Copy parquet artifacts from S3
Keep centroid collections
Recompute clusters instead of copying
Retriever migration options
Show child attributes
Keep same retriever IDs (avoid conflicts)
Migrate user interaction data
Migrate past execution history
Pre-flight check all references exist
Preserve original resource IDs in target
Validate only, don't execute
Webhook URL for status notifications
Current status
draft, validating, pending, in_progress, completed, failed, cancelled Progress tracking
Show child attributes
Overall migration status
draft, validating, pending, in_progress, completed, failed, cancelled Overall progress %
0 <= x <= 100Currently executing stage
namespace_setup, batch_creation, batch_processing, cluster_execution, taxonomy_enrichment, benchmark_evaluation, finalization Progress for each stage
Show child attributes
Stage name
namespace_setup, batch_creation, batch_processing, cluster_execution, taxonomy_enrichment, benchmark_evaluation, finalization Stage status
draft, validating, pending, in_progress, completed, failed, cancelled Stage start time
Stage completion time
Progress %
0 <= x <= 100Total items to process
x >= 0Items completed
x >= 0Items failed
x >= 0Error if failed
Progress for each resource
Show child attributes
Resource ID
Resource type
bucket, collection, taxonomy, cluster, retriever Resource status
draft, validating, pending, in_progress, completed, failed, cancelled Progress %
0 <= x <= 100Error if failed
Migration start time
Estimated completion time
Creation timestamp
Validation result
Show child attributes
Whether migration can proceed
Estimated migration duration
Dependency graph
Show child attributes
All resource nodes
Show child attributes
Resource ID
Resource type
bucket, collection, taxonomy, cluster, retriever IDs of resources this depends on
Dependency tier (0=no deps)
x >= 0Topologically sorted execution order
Celery task ID
Start timestamp
Completion timestamp
Error if failed
Additional metadata
Was this page helpful?