List OPEN entity-merge clusters (server-side grouped pair-suggestions)

GET

/api/v1/review/clusters

const url = 'https://api.yggy.tech/api/v1/review/clusters?page=1&pageSize=20';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.yggy.tech/api/v1/review/clusters?page=1&pageSize=20' \
  --header 'Authorization: Bearer <token>'

Authorizations

bearerAuth
apiKeyAuth

Parameters

Query Parameters

projectId

string

page

number

default: 1 >= 1

pageSize

number

default: 20 >= 1 <= 100

Header Parameters

host

string | null

x-yggy-organization-id

string | null

Responses

200

Cluster list

application/json

object

clusters

required

Array<object>

object

clusterKey

required

string

label

required

string

score

required

number | null

entities

required

Array<object>

object

required

string

label

required

string

type

required

string

canonicalId

string | null

identityUri

string | null

identityNamespaceUri

string | null

identityAuthorityApproved

boolean | null

identitySourceField

string | null

identitySourceValue

string | null

tripleCount

required

integer | null

suggestionIds

required

Array<string>

createdAt

required

string

reopeners

required

Array<object>

object

required

string

externalId

string | null

displayName

string | null

email

string | null

projectExternalId

required

string | null

suggestedWinnerId

required

string | null

analysisReason

string | null

Allowed values: source-identifier same-label same-label-location join-key label-containment identity-conflict do-not-merge unapproved-identity unapproved-identity-conflict weak-overlap mixed-types already-canonical missing-project always-review unexplained same-label-context label-containment-context ambiguous-expansion role-conflict parent-subsidiary

total

required

number

page

required

number

pageSize

required

number

totalPages

required

number

Example

{
  "clusters": [
    {
      "analysisReason": "source-identifier"
    }
  ]
}