Skip to main content
POST
Evaluate Entitlement Selection

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Authorization
string
header
required

This API uses OAuth2 with the Client Credential flow. Client Credentials must be sent in the BODY, not the headers. For an example of how to implement this, refer to the c1TokenSource.Token() function.

Path Parameters

analysis_id
string
required

Custom analysis whose cohort and entitlement results define the selection.

Body

application/json

EvaluateEntitlementSelectionRequest selects analyzed entitlements using an inclusive coverage cutoff plus optional manual overrides.

explicitlyExcluded
Entitlement Ref · object[] | null

Analyzed entitlements to exclude when they meet the cutoff.

explicitlyIncluded
Entitlement Ref · object[] | null

Analyzed entitlements to include even when they fall below the cutoff.

includeFacets
boolean

Whether to return profile attribute facets for exact holders.

minimumCoverageBasisPoints
integer<int32>

Inclusive minimum entitlement coverage in basis points, where 8000 is 80%.

Response

200 - application/json

EvaluateEntitlementSelectionResponse contains the exact impact of the resolved entitlement selection.

EvaluateEntitlementSelectionResponse contains the exact impact of the resolved entitlement selection.

coreHolderFacets
Attribute Facet · object[] | null

Profile attribute facets narrowed to users who hold every selected entitlement.

selectedEntitlementCount
integer<int32>

Number of entitlements in the resolved selection.

usersWithAllEntitlements
integer<int32>

Exact number of cohort users who hold every selected entitlement.