Skip to main content
GET
/
v0
/
measurements
/
generate
Compute a measurement report on the fly
curl --request GET \
  --url https://{hostname}.gable.ai/v0/measurements/generate \
  --header 'X-API-KEY: <api-key>'
{
  "metadata": {
    "baseTimestamp": "<string>",
    "compareTimestamp": "<string>",
    "comparisonDate": "<string>",
    "componentName": "<string>",
    "baseNamespace": "<string>",
    "compareNamespace": "<string>",
    "baseComponentId": "<string>",
    "compareComponentId": "<string>",
    "baseVersionId": "<string>",
    "compareVersionId": "<string>",
    "mappingJoinMultiplicity": {
      "baseDuplicateKeyCount": 123,
      "compareDuplicateKeyCount": 123,
      "crossProductKeyCount": 123,
      "extraJoinedRows": 123,
      "samples": [
        {
          "pathPayloadName": "<string>",
          "ingressField": "<string>",
          "egressField": "<string>",
          "baseCount": 123,
          "compareCount": 123,
          "joinedRows": 123,
          "extraJoinedRows": 123
        }
      ]
    }
  },
  "summary": {
    "fullyQualified": {
      "total": 123,
      "full": 123,
      "partial": 123,
      "missing": 123,
      "highQualityTotal": 123,
      "highQualityFull": 123,
      "highQualityPartial": 123,
      "highQualityMissing": 123,
      "lowQualityTotal": 123,
      "lowQualityFull": 123,
      "lowQualityPartial": 123,
      "lowQualityMissing": 123
    },
    "partiallyQualified": {
      "total": 123,
      "full": 123,
      "partial": 123,
      "missing": 123,
      "highQualityTotal": 123,
      "highQualityFull": 123,
      "highQualityPartial": 123,
      "highQualityMissing": 123,
      "lowQualityTotal": 123,
      "lowQualityFull": 123,
      "lowQualityPartial": 123,
      "lowQualityMissing": 123
    }
  },
  "paths": [
    {
      "pathId": "<string>",
      "ingress": {
        "id": "<string>",
        "payloadName": "<string>",
        "signatureName": "<string>",
        "schemaName": "<string>"
      },
      "egress": {
        "id": "<string>",
        "payloadName": "<string>",
        "signatureName": "<string>",
        "schemaName": "<string>"
      },
      "notes": "<string>",
      "dimensions": {},
      "details": {
        "ingressFields": [
          {
            "fieldName": "<string>",
            "fieldType": "<string>"
          }
        ],
        "egressFields": [
          {
            "fieldName": "<string>",
            "fieldType": "<string>"
          }
        ],
        "mappings": [
          {
            "ingressField": "<string>",
            "egressField": "<string>"
          }
        ],
        "codeSteps": [
          {
            "stepOrder": 123,
            "ingressField": "<string>",
            "egressField": "<string>"
          }
        ],
        "pathAnchors": [
          {
            "anchorName": "<string>",
            "filePath": "<string>",
            "baseLine": "<string>",
            "compareLine": "<string>"
          }
        ]
      }
    }
  ],
  "extraPaths": [
    {
      "extraPathId": "<string>",
      "ingressPayload": "<string>",
      "egressPayload": "<string>",
      "pathPayloadName": "<string>"
    }
  ]
}

Authorizations

​
X-API-KEY
string
header
required

Query Parameters

​
componentId
string
required

Component to measure.

​
compareVersionId
string
required

Version to evaluate against the base.

​
baseVersionId
string

Base (ground-truth) version ID. Defaults to latest if omitted.

​
compareComponentId
string

Component ID for the compare version. Defaults to componentId if omitted. Use when comparing across namespaces.

​
scanOnly
enum<string>
default:false

When true, use raw scan data. When false, use projected data.

Available options:
true,
false
​
applyIEInclusionFilter
enum<string>
default:true

When true, apply IE inclusion filtering to lineage data before generating the measurement report.

Available options:
true,
false

Response

Computed measurement report

Top-level object containing all comparison data between a base and compare lineage export.

​
metadata
object
required

Timestamps, file paths, and component info.

​
summary
object
required

Aggregate counts and percentages.

​
paths
object[]
required

Per-path comparison results.

​
extraPaths
object[]
required

Paths in compare but not in base.