Баримт бичиг / API лавлах

Эрсдэл

Залилан, эрсдэлийн дохио.

GET/v1/workspaces/{workspaceId}/partners/{partnerId}/risk

Risk score and open events of one partner (partner detail panel).

Шаардлагатай API түлхүүрийн хамрах хүрээ: partners.read

Параметр (2)
НэрБайрлалТөрөлЗаавалТайлбар
workspaceIdpathstringтийм
partnerIdpathstringтийм

Хариу: 200 PartnerRiskDto

GET/v1/workspaces/{workspaceId}/risk/events

List risk events: severity first, then last detection (R49).

Шаардлагатай API түлхүүрийн хамрах хүрээ: partners.read

Параметр (10)
НэрБайрлалТөрөлЗаавалТайлбар
workspaceIdpathstringтийм
statusquerystringComma list of `open` (default), `resolved`, `expired`, `shadow`, or `all`.
severityquerystring
ruleKeyquerystring
partnerIdquerystring
groupIdquerystring
searchquerystringPartner name contains.
intervalquerystring`24h`, `7d`, `30d`, `90d`: last detection within.
pagequeryinteger (int32)
pageSizequeryinteger (int32)

Хариу: 200 RiskEventDto[]

POST/v1/workspaces/{workspaceId}/risk/events/bulk-resolve

Resolve up to 100 events as safe, one transaction each; returns a result per id.

Шаардлагатай API түлхүүрийн хамрах хүрээ: partners.write

Параметр (1)
НэрБайрлалТөрөлЗаавалТайлбар
workspaceIdpathstringтийм
Хүсэлтийн бие (BulkBody)
НэрТөрөлЗаавалТайлбар
actionstringтийм`approve` or `reject`.
partnerIdsstring[]тийм
groupIdstring
tagIdsarray
tagNamesarray
rejectionReasonstring
rejectionNotestring
reapplicationTimeframestring
flagForFraudboolean
flagForFraudReasonstring

Хариу: 200 BulkResult[]

GET/v1/workspaces/{workspaceId}/risk/events/{eventId}

One event with evidence, score lines and held commissions.

Шаардлагатай API түлхүүрийн хамрах хүрээ: partners.read

Параметр (2)
НэрБайрлалТөрөлЗаавалТайлбар
workspaceIdpathstringтийм
eventIdpathstringтийм

Хариу: 200 RiskEventDetail

POST/v1/workspaces/{workspaceId}/risk/events/{eventId}/commissions

Mark the event's held commissions fraud or canceled (all or a selection); the event stays open until resolved or the partner is banned.

Шаардлагатай API түлхүүрийн хамрах хүрээ: partners.write

Параметр (2)
НэрБайрлалТөрөлЗаавалТайлбар
workspaceIdpathstringтийм
eventIdpathstringтийм
Хүсэлтийн бие (MarkBody)
НэрТөрөлЗаавалТайлбар
commissionIdsarray`cm_...` ids; every one must be held by this event.
allboolean
statusstringтийм`fraud` or `canceled`.
applyToRelationshipbooleanSpec 24 R32: the status follows the (customer, partner) relationship.

Хариу: 200 MarkOut

POST/v1/workspaces/{workspaceId}/risk/events/{eventId}/reopen

Reopen a safe resolution made in the last 30 days.

Шаардлагатай API түлхүүрийн хамрах хүрээ: partners.write

Параметр (2)
НэрБайрлалТөрөлЗаавалТайлбар
workspaceIdpathstringтийм
eventIdpathstringтийм

Хариу: 200 RiskEventDetail

POST/v1/workspaces/{workspaceId}/risk/events/{eventId}/resolve

Resolve as safe: held commissions return to pending, the evidence is remembered.

Шаардлагатай API түлхүүрийн хамрах хүрээ: partners.write

Параметр (2)
НэрБайрлалТөрөлЗаавалТайлбар
workspaceIdpathstringтийм
eventIdpathstringтийм
Хүсэлтийн бие (ResolveBody)
НэрТөрөлЗаавалТайлбар
notestring
excludeFromRiskbooleanAlso exclude the partner from future monitoring (`exclude_from_risk`).

Хариу: 200 RiskEventDetail

GET/v1/workspaces/{workspaceId}/risk/referral-sources

Banned referral patterns and the paid-traffic allow list.

Шаардлагатай API түлхүүрийн хамрах хүрээ: partners.read

Параметр (1)
НэрБайрлалТөрөлЗаавалТайлбар
workspaceIdpathstringтийм

Хариу: 200 SourceDto[]

POST/v1/workspaces/{workspaceId}/risk/referral-sources

Add a pattern (* wildcard); at most 200 per program.

Шаардлагатай API түлхүүрийн хамрах хүрээ: partners.write

Параметр (1)
НэрБайрлалТөрөлЗаавалТайлбар
workspaceIdpathstringтийм
Хүсэлтийн бие (SourceBody)
НэрТөрөлЗаавалТайлбар
patternstringтийм
kindstringтийм

Хариу: 201 SourceDto

DELETE/v1/workspaces/{workspaceId}/risk/referral-sources/{sourceId}

Remove a pattern.

Шаардлагатай API түлхүүрийн хамрах хүрээ: partners.write

Параметр (2)
НэрБайрлалТөрөлЗаавалТайлбар
workspaceIdpathstringтийм
sourceIdpathstringтийм

Хариу: 204

GET/v1/workspaces/{workspaceId}/risk/rules

The thirteen rules with their effective parameters.

Шаардлагатай API түлхүүрийн хамрах хүрээ: partners.read

Параметр (1)
НэрБайрлалТөрөлЗаавалТайлбар
workspaceIdpathstringтийм

Хариу: 200 RuleDto[]

PUT/v1/workspaces/{workspaceId}/risk/rules

Update one rule. Disabling resolves its open events and releases their commissions.

Шаардлагатай API түлхүүрийн хамрах хүрээ: partners.write

Параметр (1)
НэрБайрлалТөрөлЗаавалТайлбар
workspaceIdpathstringтийм
Хүсэлтийн бие (RuleBody)
НэрТөрөлЗаавалТайлбар
ruleKeystringтийм
enabledboolean
paramsobjectPartial object: only the listed parameters change.
modestring`live` or `shadow` (dry run, R51f).

Хариу: 200 RuleDto

GET/v1/workspaces/{workspaceId}/risk/settings

Program risk thresholds (defaults when never changed).

Шаардлагатай API түлхүүрийн хамрах хүрээ: partners.read

Параметр (1)
НэрБайрлалТөрөлЗаавалТайлбар
workspaceIdpathstringтийм

Хариу: 200 SettingsDto

PUT/v1/workspaces/{workspaceId}/risk/settings

Change the thresholds; the cached score and holding flag of open events are recomputed.

Шаардлагатай API түлхүүрийн хамрах хүрээ: partners.write

Параметр (1)
НэрБайрлалТөрөлЗаавалТайлбар
workspaceIdpathstringтийм
Хүсэлтийн бие (SettingsBody)
НэрТөрөлЗаавалТайлбар
holdMinSeveritystring
payoutBlockScoreinteger (int32)
eventTtlDaysinteger (int32)
autoCancelSelfReferralboolean
autoBanOnScoreinteger (int32)A number sets it, `null` clears it; omit to keep.

Хариу: 200 SettingsDto

GET/v1/workspaces/{workspaceId}/risk/summary

Header badge numbers of the risk tab.

Шаардлагатай API түлхүүрийн хамрах хүрээ: partners.read

Параметр (1)
НэрБайрлалТөрөлЗаавалТайлбар
workspaceIdpathstringтийм

Хариу: 200 SummaryDto