Skip to content
Docs
Follow yggy on LinkedInFollow @yggy_tech on X

List review suggestions for the current org

GET
/api/v1/projects/{projectId}/review/suggestions
 
curl --request GET \
  --url 'https://api.yggy.tech/api/v1/projects/example/review/suggestions?status=OPEN&kind=ENTITY_MERGE&page=1&pageSize=20' \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
projectId
required
string
>= 1 characters

Query Parameters

Section titled “Query Parameters ”
status
string
Allowed values: OPEN MERGED DISCARDED KEPT_APART
resolved
boolean | null
kind
string
Allowed values: ENTITY_MERGE TRIPLE_CONFLICT
documentId
string
projectId
string
page
number
default: 1 >= 1
pageSize
number
default: 20 >= 1 <= 100

Header Parameters

Section titled “Header Parameters ”
host
string | null
x-yggy-organization-id
string | null

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Review list

Media type application/json
object
suggestions
required
Array<object>
object
id
required
string
externalId
required
string
kind
required
string
Allowed values: ENTITY_MERGE TRIPLE_CONFLICT
status
required
string
Allowed values: OPEN MERGED DISCARDED KEPT_APART
score
required
number | null
entityA
object
id
required
string
label
required
string
type
required
string
canonicalId
string | null
entityB
object
id
required
string
label
required
string
type
required
string
canonicalId
string | null
tripleA
object
id
required
string
predicate
required
string
trustScore
required
number | null
subject
required
object
id
required
string
label
required
string
type
required
string
object
required
object
id
required
string
label
required
string
type
required
string
tripleB
object
id
required
string
predicate
required
string
trustScore
required
number | null
subject
required
object
id
required
string
label
required
string
type
required
string
object
required
object
id
required
string
label
required
string
type
required
string
document
object
id
required
string
title
required
string
externalId
required
string
createdAt
required
string
createdBy
object
id
required
string
externalId
string | null
displayName
string | null
email
string | null
resolvedAt
string | null
resolvedBy
object
id
required
string
externalId
string | null
displayName
string | null
email
string | null
resolution
string | null
Allowed values: merged-into-a merged-into-b discarded both-correct auto-merged-cross-prefix cluster-merged superseded-by-cascade kept-apart
note
string | null
total
required
number
page
required
number
pageSize
required
number
totalPages
required
number
Example 
{
  "suggestions": [
    {
      "kind": "ENTITY_MERGE",
      "status": "OPEN",
      "resolution": "merged-into-a"
    }
  ]
}