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

Get a single review suggestion

GET
/api/v1/review/suggestions/{id}
 
curl --request GET \
  --url https://api.yggy.tech/api/v1/review/suggestions/example \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
string

Header Parameters

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

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Review detail

Media type application/json
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
Example 
{
  "kind": "ENTITY_MERGE",
  "status": "OPEN",
  "resolution": "merged-into-a"
}

404

Section titled “404 ”

Not found

Media type application/json
object
success
required
boolean
error
required
object
message
required
string
code
required
string
Allowed values: INTERNAL_ERROR VALIDATION_ERROR UNAUTHORIZED RATE_LIMITED ORG_REQUIRED FORBIDDEN NOT_FOUND CONFLICT PROJECT_DENIED USAGE_LIMIT_EXCEEDED HUGINN_ERROR HUGINN_STREAM_ERROR QUERY_FAILED PROVIDER_CONFLICT PROVIDER_CONFIG_INVALID PROVIDER_NOT_CONNECTED PROVIDER_RATE_LIMITED PROJECT_MEMBER_USER_NOT_IN_ORG PROJECT_MEMBER_UNKNOWN_ROLE PROJECT_MEMBER_LAST_OWNER PROJECT_CONFLICT STORAGE_NOT_CONFIGURED BILLING_NOT_CONFIGURED LICENSE_INACTIVE PLAN_REQUIRED MEMBER_LIMIT_REACHED SAGA_ASK_QUOTA_EXCEEDED SAGA_ASK_RATE_LIMITED SAGA_ASK_BUSY SAGA_ASK_PAUSED SAGA_ASK_UPSTREAM SAGA_DICTATION_BUSY SAGA_DICTATION_UNAVAILABLE SAGA_SHARE_LINK_LIMIT PROJECT_MEMBERSHIP_JWT_TOO_LARGE WEBHOOK_URL_INVALID WEBHOOK_ADDRESS_BLOCKED WEBHOOK_EVENT_UNKNOWN WEBHOOK_ENDPOINT_LIMIT WEBHOOK_ENDPOINT_DISABLED WEBHOOK_DELIVERY_IN_PROGRESS ORG_KEY_PERSONAL_SCOPE API_KEY_PERMISSION_EXCEEDS_ROLE API_KEY_NO_PERMISSIONS ORG_KEY_GRAPH_SCOPE_UNAVAILABLE ORG_KEY_TOO_MANY_PROJECTS SENDER_IS_LOGIN_EMAIL SENDER_TAKEN
details
Example 
{
  "success": false,
  "error": {
    "code": "INTERNAL_ERROR"
  }
}