Skip to main content
POST
PreviewFold

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
matcher
id_pattern · object
required

The matcher to preview.

sampleSize
integer<int32> | null

How many sample entities to return, at most. Defaults to 20.

Required range: 1 <= x <= 200
foldId
string<uuid> | null

When previewing a change to an existing fold, its id, so the fold is not reported as overlapping with itself.

Response

200 - application/json

Success

entityCount
integer<int32>

How many entities in lineage the matcher folds.

sampleEntityIds
string[]

A sample of the entity ids folded, in id order.

edgeCount
integer<int32>

How many lineage edges connect a folded entity to anything. Edges between two folded entities disappear into the fold's node.

separatedEntityCount
integer<int32>

How many folded entities are shown today on one node with other entities that the matcher does not fold, typically the same table as a transformation model or a catalog entry sees it. Folded, such an entity moves to the fold's node and the others stay on a node of their own.

sampleSeparatedEntities
SeparatedEntity · object[]

A sample of them.

overlappingFoldIds
string[]

Enabled folds that already match some of the same entities. An entity matched by more than one fold goes to the oldest of them.