Data & Analytics

Evaluate a supplied profile panel against one eligibility snapshot

Evaluates up to 10 caller-supplied named profiles against one pinned exhaustive graph, one union product query, and one proof read. Aggregate counts describe only the supplied panel and must never be extrapolated to a population, audience, approval, or conversion claim. Profile facts and results are private and returned with Cache-Control: no-store.

Authentication required: Pass your API key in the X-API-Key header.

post/v1/eligibility/cohort/evaluate

Request

  • Base URL: https://api.rateapi.dev
  • URL: https://api.rateapi.dev/v1/eligibility/cohort/evaluate
  • Auth: API key in header X-API-Key

Request body

productProduct required(unresolved $ref)
limitinteger

Maximum aggregate institutions and deduplicated exact offers returned.

Response

Per-profile results plus deduplicated bounded summary for the supplied panel.

productProduct required(unresolved $ref)
profilesobject[] required

Per-profile graph-first results for this supplied panel only.

aggregateobject required

Deduplicated institutions and exact offers observed across this supplied panel.

methodologyobject required

Scope, denominator, deduplication, and non-extrapolation rules for interpreting the aggregate.

snapshotobject required

Shared graph generation, publication identities, and rate-read boundary used for every profile.

semanticsstring required

Positive-evidence and unknown-safe cohort semantics.

disclosurestring required

Required statement that this supplied panel is not a population, approval, or conversion estimate.

Changes

No recorded changes to this operation across all 1 revision of this API.