Get Ranked List for Contextual Bandit

Returns a ranked list of variants for a contextual multi-armed bandit (autotune) experiment. The ranking is based on predicted performance.

Returns a ranked list of variants for a contextual multi-armed bandit (autotune) experiment. The ranking is based on predicted performance.

post/v1/get_ranked_list

Authorizations

statsig-api-keystringrequired

SDK API key (Server Secret or Client SDK Key)

Body

application/json
configNamestringrequired

Name of the contextual bandit (autotune) experiment

Constraints:min length: 2max length: 100pattern: ^[a-zA-Z0-9_\- ]+$
userobject

User object containing identification and attributes for evaluation. At minimum, provide at least one identifier.

Show child attributes
userIDstring

Primary user identifier

Example:user-123
emailstring

User email address

Example:user@example.com
Constraints:format: email
ipstring

User IP address for geo-targeting

Example:192.168.1.1
userAgentstring

User agent string for device/browser targeting

Example:Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36
countrystring

2-letter country code (ISO 3166-1 alpha-2)

Example:US
localestring

Locale/language code

Example:en_US
appVersionstring

Application version

Example:1.2.3
customobject

Custom user attributes for targeting (string, number, boolean, or array of strings)

Example:{"subscription_plan":"premium","account_age_days":45,"is_beta_tester":true}
privateAttributesobject

Private attributes used for evaluation but not logged to analytics

Example:{"internal_user_id":"12345"}
customIDsobject

Additional custom identifier mappings

Example:{"companyID":"company-456","deviceID":"device-789"}
statsigEnvironmentobject

Environment tier for targeting

tierstring

Environment tier

Allowed values:productionstagingdevelopment
statsigMetadataobject

SDK metadata for tracking SDK type, version, and other diagnostic information

Example:{"sdkType":"js-client","sdkVersion":"4.20.0","exposureLoggingDisabled":false}
Show child attributes
sdkTypestring

SDK type sending the request (e.g., js-client)

sdkVersionstring

SDK version

exposureLoggingDisabledboolean

When true, prevents the HTTP API from automatically logging exposures. Use this only if you will handle exposure logging yourself.

Response

application/json
200· Ranked list of variants
valueobject[]

Array of variants ranked by predicted performance

Was this helpful?