Skip to main content
POST
Analyze relationships
See the integration guide for the workflow and interpretation of this response.

Authorizations

Authorization
string
header
required

Proposed server-to-server API key. No client request HMAC signing scheme is specified.

Headers

X-Client-Request-Id
string

Caller correlation reference; not an idempotency guarantee.

Body

application/json
selection
object[]
required

Explicit supplied outcome/listing references; resolved canonical outcomes are deduplicated for set statistics.

Minimum array length: 1

Supply exactly one outcome_id or listing_id; never both.

scenario_pins
object[]

Optional explicit family/version pins; returned even when selected automatically.

paying_definition
enum<string>
default:POSITIVE_PAYOUT

POSITIVE_PAYOUT by default; FULL_PAYOUT distinguishes fractional settlements.

Available options:
POSITIVE_PAYOUT,
FULL_PAYOUT
include
enum<string>[]

Requested outputs; default PAIRS, BASKET and WITNESSES.

Available options:
PAIRS,
BASKET,
WITNESSES,
EVIDENCE
witness_limit
integer
default:5

Maximum example witnesses per finding; never limits the domain used to establish the finding.

Required range: x >= 0
require_complete_coverage
boolean
default:true

True rejects incomplete selected-set scope; false explicitly labels analysis of the supported subset.

Response

200 - application/json

Success.

relationships
object[]
required
baskets
object[]
required
coverage
object
required
versions
object
required