Skip to main content

​
Overview

Traceability endpoints help you track connections between requirements and artifacts across the development lifecycle.

​
Get Traceability Matrix

curl -X GET "https://api.conformly.ai/api/v1/traceability/matrix?workspace_id=uuid&standard_id=uuid" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN"

{
  "matrix": [
    {
      "requirement_id": "req-1",
      "requirement_text": "System shall perform X",
      "upstream_links": [
        {
          "artifact_id": "art-1",
          "artifact_name": "Safety Goal",
          "link_type": "satisfies"
        }
      ],
      "downstream_links": [
        {
          "artifact_id": "art-2",
          "artifact_name": "Technical Requirement",
          "link_type": "decomposes_to"
        }
      ],
      "status": "complete"
    }
  ],
  "gaps": 3,
  "coverage": 85.5
}

​
Get Traceability Gaps

curl -X GET "https://api.conformly.ai/api/v1/traceability/gaps?workspace_id=uuid" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN"

{
  "gaps": [
    {
      "requirement_id": "req-1",
      "gap_type": "missing_downstream",
      "description": "Requirement has no corresponding test case",
      "severity": "high"
    }
  ],
  "total_gaps": 5
}

curl -X POST "https://api.conformly.ai/api/v1/traceability/links" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "workspace_id": "uuid",
    "source_id": "req-1",
    "target_id": "art-2",
    "link_type": "decomposes_to"
  }'

​
Get Workspace Completeness

Aggregated completeness metrics across the V‑Model chain. 
curl -X GET "https://api.conformly.ai/api/v1/traceability/completeness?workspace_id=uuid" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN"

{
  "workspace_id": "uuid",
  "total_artifacts": 128,
  "total_links": 420,
  "upstream_completeness": 72,
  "downstream_completeness": 64,
  "verification_completeness": 58,
  "evidence_completeness": 43,
  "overall_completeness": 59,
  "gaps": []
}

​
Run Comprehensive Traceability Analysis

Detects all gap types (orphan upstream/downstream, missing verification/evidence, broken chain, ASIL inconsistency) and returns a summary. 
curl -X GET "https://api.conformly.ai/api/v1/traceability/analyze?workspace_id=uuid" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN"

{
  "workspace_id": "uuid",
  "analyzed_at": "2026-01-18T01:35:00Z",
  "gaps": [
    {
      "artifact_id": "art-1",
      "gap_type": "orphan_upstream",
      "severity": "high",
      "description": "No upstream link to Functional Safety Requirement",
      "suggested_action": "Link to parent requirement using 'derives_from' or 'satisfies'"
    }
  ],
  "summary": {
    "orphan_upstream": 3,
    "orphan_downstream": 5,
    "missing_verification": 4,
    "missing_evidence": 2,
    "broken_chain": 1,
    "asil_inconsistency": 0
  },
  "severity_counts": { "critical": 0, "high": 6, "medium": 7, "low": 2 },
  "total_gaps": 15,
  "total_artifacts": 128,
  "total_links": 420,
  "completeness_percentage": 59
}