Unify and manage your data

Match precision labeling APIs

Learn more about the APIs that let you save, retrieve, and delete match labels required to calculate match precision.

Match precision helps you measure how accurately your tenant identifies true matches versus false matches. To calculate precision, the system requires labeled data that indicates whether specific entity pairs are a Match or Not a match. You can create and manage this labeled data using the Match precision labeling APIs. These APIs let you save new labels, retrieve existing labels for a given entity, or delete labels when they are no longer needed.

Save match labels

Method
POST /reltio/api/{tenantId}/matching/accuracy/labels
Description
Saves one or more match labels for reviewed entity pairs.
Request body example
{
  "labels": [
    {
      "entityType": "Individual",
      "entityId1": "entity1",
      "entityId2": "entity2",
      "decision": "MATCH"
      }
    },
    {
      "entityType": "Individual",
      "entityId1": "entity1",
      "entityId2": "entity3",
      "decision": "NOT_MATCH"
    }
  ]
}
Response example
{
  "successful": true,
  "result": {
    "labels": [
      {
        "entityType": "Individual",
        "entityId1": "entity1",
        "entityId2": "entity2",
        "decision": "MATCH"
      },
      {
        "entityType": "Individual",
        "entityId1": "entity1",
        "entityId2": "entity3",
        "decision": "NOT_MATCH"
      }
    ]
  }
}

Get match labels for an entity

Method
GET /reltio/api/{tenantId}/matching/accuracy/entities/{entityId}/labels
Description
Returns all match labels for the specified entity ID.
Response example
[
  {
    "id": "6a504285-a414-49e3-9faa-05316d14369f",
    "timestamp": 1749651587921,
    "user": "user@customer.com",
    "entityType": "Individual",
    "entityId1": "entity1",
    "entityId2": "entity2",
    "decision": "MATCH"
  },
  {
    "id": "ed383d7d-97a6-4575-bcc8-e21f83498ed9",
    "timestamp": 1749651587921,
    "user": "user@customer.com",
    "entityType": "Individual",
    "entityId1": "entity1",
    "entityId2": "entity3",
    "decision": "NOT_MATCH"
  }
]

Delete match labels for an entity

Method
DELETE /reltio/api/{tenantId}/matching/accuracy/entities/{entityId}/labels
Description
Deletes all match labels for the specified entity ID.
Response example
{
  "success": true
}
Note: It is not possible to delete or update recently created labels. Attempts return a 400 Bad Request if the labels are still in the Google BigQuery (GBQ) streaming buffer.