Get Ranked List for Contextual Bandit

curl --request POST \
  --url https://api.statsig.com/v1/get_ranked_list \
  --header 'Content-Type: application/json' \
  --header 'statsig-api-key: <api-key>' \
  --data '
{
  "configName": "product_recommendation_bandit",
  "user": {
    "userID": "user-123"
  }
}
'

[
  {
    "name": "variant_a",
    "value": {
      "recommendation_algorithm": "collaborative_filtering"
    },
    "rule_id": "rule_123",
    "score": 0.85
  },
  {
    "name": "variant_b",
    "value": {
      "recommendation_algorithm": "content_based"
    },
    "rule_id": "rule_124",
    "score": 0.72
  }
]

POST

get_ranked_list

Get Ranked List for Contextual Bandit

curl --request POST \
  --url https://api.statsig.com/v1/get_ranked_list \
  --header 'Content-Type: application/json' \
  --header 'statsig-api-key: <api-key>' \
  --data '
{
  "configName": "product_recommendation_bandit",
  "user": {
    "userID": "user-123"
  }
}
'

[
  {
    "name": "variant_a",
    "value": {
      "recommendation_algorithm": "collaborative_filtering"
    },
    "rule_id": "rule_123",
    "score": 0.85
  },
  {
    "name": "variant_b",
    "value": {
      "recommendation_algorithm": "content_based"
    },
    "rule_id": "rule_124",
    "score": 0.72
  }
]

Authorizations

statsig-api-key

string

header

required

SDK API key (Server Secret or Client SDK Key)

Body

application/json

configName

string

required

Name of the contextual bandit (autotune) experiment

Required string length: 2 - 100

user

object

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

Show child attributes

user.userID

string

Primary user identifier

Example:

"user-123"

user.email

string<email>

User email address

Example:

"[email protected]"

user.ip

string

User IP address for geo-targeting

Example:

"192.168.1.1"

user.userAgent

string

User agent string for device/browser targeting

Example:

"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36"

user.country

string

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

Example:

"US"

user.locale

string

Locale/language code

Example:

"en_US"

user.appVersion

string

Application version

Example:

"1.2.3"

user.custom

object

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

Example:

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

user.privateAttributes

object

Private attributes used for evaluation but not logged to analytics

Example:

{ "internal_user_id": "12345" }

user.customIDs

object

Additional custom identifier mappings

Show child attributes

user.customIDs.{key}

string

Example:

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

user.statsigEnvironment

object

Environment tier for targeting

Show child attributes

user.statsigEnvironment.tier

enum<string>

Environment tier

Available options:

production,

staging,

development

statsigMetadata

object

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

Example:

{
  "sdkType": "js-client",
  "sdkVersion": "4.20.0"
}

Response

Ranked list of variants

name

string

required

Variant name

value

object

required

Variant parameter values

rule_id

string | null

required

Rule ID for this variant

score

number<double>

required

Predicted performance score for this variant

Get Layer Parameters

Log Custom Events

⌘I

SDK Quickstarts

SDK Concepts

Client SDKs

Server SDKs

AI SDKs

More SDK Methods

Console API Reference

Statsig CLI

HTTP API Reference

Get Ranked List for Contextual Bandit

Authorizations

Body

Response