Entity merge tree

Learn about the Entity merge tree endpoint

This endpoint retrieves a structured sequence of merges and offers insights into merge operations and contributors' URIs. It provides details such as merge time, reasons for merge (like 'Merge on the fly'), users executing the merge, and crosswalks associated with winners and losers. This endpoint aids in troubleshooting and understanding your merge history.

Request

GET {TenantURL}/entities/{{entityid}}/_crosswalkTree

Table 1. Parameters
Parameter	Name	Req	Details	Examples
Header	`Authorization`	Yes	Information about authentication access token in format `Bearer <accessToken>` (see details in Authentication API).

Response

Table 2. Example - Format of a Response
Parameter	Description	Value for this example
`merges`	Shows the number of merges.	"2"
`time`	The time when the merge operation was executed.	"1716549555066"
`mergeReason`	Reason for the merge: Merge by crosswalks Merge by hand Merge on the fly Merges found by background merge process	"Merge on the fly"
`mergeRules`	If a match rule was applied, `mergeRules` contains the label of the corresponding match rule.	`mergeRules` = "same name and address auto rule"
`user`	The user who performed the merge.	"john.doe"
`merges.crosswalks` `merges.losers.crosswalks`	Shows loser/winner crosswalks for the specified merge operation. Winner = crosswalks specified in the root of the `merges` section. Loser = crosswalks specified in the `losers` section for the corresponding merge.	For the merge at "1716549555066": Winner: `"crosswalks": [ { "uri": "entities/0000NA9/crosswalks/1msz2n", "type": "configuration/sources/DEA", "ownerType": "entity", "value": "ind001Dnb" }, { "uri": "entities/0000NA9/crosswalks/1mt3J3", "type": "configuration/sources/FB", "ownerType": "entity", "value": "ind001Fb" } ]` Loser: `"crosswalks": [ { "uri": "entities/0000NA9/crosswalks/1mtX8r", "type": "configuration/sources/FB", "ownerType": "entity", "value": "ind003Fb" } ]`
`merges.urimerges.losers.uri`	Contains URIs of available contributors.	`uri`: "entities/0000NA9"
`phantomEntity`	Shows that the specified entity had been created but was merged with the winner before saving it in the database.	"true"
`merges.mergeCrosswalks`	Shows crosswalks of the loser entity. Note: To suppress `mergeCrosswalks` in the API response, set `excludeMergeCrosswalksFromMergeTree` optional field to `true` in the tenant's configuration.	`"mergeCrosswalks": [ { "uri": "DEA", "value": "ind001Dnb" }, { "uri": "FB", "value": "ind003Fb" } ]`

Example:

{
    "merges": [
        {
            "time": 1716549555066,
            "mergeReason": "Merge on the fly",
            "mergeRules": "",
            "user": "john.doe",
            "losers": [
                {
                    "uri": "entities/0000Zwv",
                    "crosswalks": [
                        {
                            "uri": "entities/0000NA9/crosswalks/1mtX8r",
                            "type": "configuration/sources/FB",
                            "ownerType": "entity",
                            "value": "ind003Fb"
                        }
                    ],
                    "phantomEntity": true
                }
            ],
            "mergeCrosswalks": [
                {
                    "uri": "DEA",
                    "value": "ind001Dnb"
                },
                {
                    "uri": "FB",
                    "value": "ind003Fb"
                }
            ]
        }
    ],
    "uri": "entities/0000NA9",
    "crosswalks": [
        {
            "uri": "entities/0000NA9/crosswalks/1msz2n",
            "type": "configuration/sources/DEA",
            "ownerType": "entity",
            "value": "ind001Dnb"
        },
        {
            "uri": "entities/0000NA9/crosswalks/1mt3J3",
            "type": "configuration/sources/FB",
            "ownerType": "entity",
            "value": "ind001Fb"
        }
    ]
}

Unify and manage your data

Entity merge tree

Footer