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.

posthttps://api.statsig.com/v1/get_ranked_list

Authorizations

statsig-api-keystringrequired

apiKey (header)

Body

application/json

configNamestringrequired

Name of the contextual bandit (autotune) experiment

userobject

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

Show child attributes

userIDstring

Primary user identifier

emailstring

User email address

ipstring

User IP address for geo-targeting

userAgentstring

User agent string for device/browser targeting

countrystring

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

localestring

Locale/language code

appVersionstring

Application version

customobject

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

privateAttributesobject

Private attributes used for evaluation but not logged to analytics

customIDsobject

Additional custom identifier mappings

statsigEnvironmentobject

Environment tier for targeting

tierstring

Environment tier

statsigMetadataobject

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

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

Get Ranked List for Contextual Bandit

curl -X POST "https://api.statsig.com/v1/get_ranked_list" \
  -H "Content-Type: application/json" \
  -H "statsig-api-key: YOUR_API_KEY" \
  -d '{
  "configName": "product_recommendation_bandit",
  "user": {
    "userID": "user-123"
  }
}'

Was this helpful?