Skip to main content

Use Cases API

Manage data use cases for business context and impact tracking.

Endpoints Overview​

MethodEndpointDescription
GET/catalog/spaces/{slug}/use-casesList use cases
POST/catalog/spaces/{slug}/use-casesCreate use case
GET/use-cases/{id}Get use case
PATCH/use-cases/{id}Update use case
DELETE/use-cases/{id}Delete use case

List Use Cases​

GET /catalog/spaces/{slug}/use-cases

Response​

[
  {
    "id": "...",
    "name": "Customer Segmentation",
    "description": "ML-powered customer clustering for marketing",
    "business_value": "15% increase in campaign conversion",
    "status": "active",
    "owner": {"id": "...", "full_name": "Marketing Team"},
    "products": [
      {"id": "...", "name": "Customer Events"},
      {"id": "...", "name": "Transaction History"}
    ],
    "created_at": "2025-06-01T00:00:00Z"
  }
]

Create Use Case​

POST /catalog/spaces/{slug}/use-cases
{
  "name": "Fraud Detection",
  "description": "Real-time fraud detection for transactions",
  "business_value": "Reduced fraud losses by $500K annually",
  "product_ids": ["product-uuid-1", "product-uuid-2"]
}

Update Use Case​

PATCH /use-cases/{use_case_id}
{
  "status": "deprecated",
  "business_value": "Migrated to new system"
}