Log Custom Exposure Events

curl --request POST \
  --url https://api.statsig.com/v1/log_custom_exposure \
  --header 'Content-Type: application/json' \
  --header 'statsig-api-key: <api-key>' \
  --data '
{
  "exposures": [
    {
      "user": {
        "userID": "user-123"
      },
      "experimentName": "checkout_flow_v2",
      "group": "Test Group",
      "ruleID": "rule_abc123",
      "secondaryExposures": [
        {
          "gate": "is_employee",
          "gateValue": "false",
          "ruleID": "default"
        }
      ]
    }
  ]
}
'

{
  "success": true
}

POST

log_custom_exposure

curl --request POST \
  --url https://api.statsig.com/v1/log_custom_exposure \
  --header 'Content-Type: application/json' \
  --header 'statsig-api-key: <api-key>' \
  --data '
{
  "exposures": [
    {
      "user": {
        "userID": "user-123"
      },
      "experimentName": "checkout_flow_v2",
      "group": "Test Group",
      "ruleID": "rule_abc123",
      "secondaryExposures": [
        {
          "gate": "is_employee",
          "gateValue": "false",
          "ruleID": "default"
        }
      ]
    }
  ]
}
'

{
  "success": true
}

Authorizations

statsig-api-key

string

header

required

SDK API key (Server Secret or Client SDK Key)

Body

application/json

exposures

object[]

required

Array of exposure events to log

Minimum array length: 1

Option 1
Option 2
Option 3
Option 4

Show child attributes

exposures.experimentName

string

required

Name of the experiment or dynamic config

Minimum string length: 1

exposures.group

string

required

Group name (use this OR ruleID)

Minimum string length: 1

exposures.user

object

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

Show child attributes

exposures.user.userID

string

Primary user identifier

Example:

"user-123"

exposures.user.email

string<email>

User email address

Example:

"[email protected]"

exposures.user.ip

string

User IP address for geo-targeting

Example:

"192.168.1.1"

exposures.user.userAgent

string

User agent string for device/browser targeting

Example:

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

exposures.user.country

string

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

Example:

"US"

exposures.user.locale

string

Locale/language code

Example:

"en_US"

exposures.user.appVersion

string

Application version

Example:

"1.2.3"

exposures.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
}

exposures.user.privateAttributes

object

Private attributes used for evaluation but not logged to analytics

Example:

{ "internal_user_id": "12345" }

exposures.user.customIDs

object

Additional custom identifier mappings

Show child attributes

exposures.user.customIDs.{key}

string

Example:

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

exposures.user.statsigEnvironment

object

Environment tier for targeting

Show child attributes

exposures.user.statsigEnvironment.tier

enum<string>

Environment tier

Available options:

production,

staging,

development

exposures.ruleID

string

Rule ID (use this OR group)

exposures.time

Exposure timestamp

exposures.secondaryExposures

object[]

Show child attributes

exposures.secondaryExposures.gate

string

required

Name of the gate

exposures.secondaryExposures.gateValue

string

required

Gate value as string ('true' or 'false')

exposures.secondaryExposures.ruleID

string

required

Rule ID that was evaluated

user

object

Shared user object for all exposures

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

202 - application/json

Exposures accepted for processing

success

boolean

required

Whether the request was successful

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

Authorizations

Body

Response