List Assignment Sources

curl --request GET \
  --url https://statsigapi.net/console/v1/experiments/assignment_sources \
  --header 'STATSIG-API-KEY: <api-key>'

{
  "message": "Entity Property Sources listed successfully.",
  "data": [
    {
      "name": "Exposures",
      "description": "",
      "tags": [],
      "sql": "SELECT * FROM shoppy-sales.experiment_data.exposures",
      "timestampColumn": "ts",
      "groupIDColumn": "group_id",
      "experimentIDColumn": "experiment_name",
      "idTypeMapping": [
        {
          "statsigUnitID": "userID",
          "column": "user_id"
        },
        {
          "statsigUnitID": "deviceID",
          "column": "device_id"
        }
      ]
    }
  ],
  "pagination": {
    "itemsPerPage": 1,
    "pageNumber": 1,
    "totalItems": 13,
    "nextPage": "/console/v1/experiments/assignment_sources?page=2&limit=1",
    "previousPage": null,
    "all": "/console/v1/experiments/assignment_sources"
  }
}

GET

console

experiments

assignment_sources

List Assignment Sources

curl --request GET \
  --url https://statsigapi.net/console/v1/experiments/assignment_sources \
  --header 'STATSIG-API-KEY: <api-key>'

{
  "message": "Entity Property Sources listed successfully.",
  "data": [
    {
      "name": "Exposures",
      "description": "",
      "tags": [],
      "sql": "SELECT * FROM shoppy-sales.experiment_data.exposures",
      "timestampColumn": "ts",
      "groupIDColumn": "group_id",
      "experimentIDColumn": "experiment_name",
      "idTypeMapping": [
        {
          "statsigUnitID": "userID",
          "column": "user_id"
        },
        {
          "statsigUnitID": "deviceID",
          "column": "device_id"
        }
      ]
    }
  ],
  "pagination": {
    "itemsPerPage": 1,
    "pageNumber": 1,
    "totalItems": 13,
    "nextPage": "/console/v1/experiments/assignment_sources?page=2&limit=1",
    "previousPage": null,
    "all": "/console/v1/experiments/assignment_sources"
  }
}

Authorizations

STATSIG-API-KEY

string

header

required

Headers

x-respect-review-settings

string

Optional header to respect review settings for mutation endpoints.

Query Parameters

limit

integer

Results per page

Example:

10

page

integer

Page number

Example:

1

Response

List Assignment Sources response

message

string

required

A simple string explaining the result of the operation.

data

object[]

required

Array of results returned by pagination limit.

Show child attributes

data.name

string

required

Unique identifier for the assignment source.

data.description

string

required

Detailed context and purpose of the assignment source.

data.tags

string[]

required

Tags for categorization and search.

data.sql

string

required

SQL query defining the data source for assignments.

data.timestampColumn

string

required

Column name representing the timestamp of assignments.

data.experimentIDColumn

string

required

Column name for the experiment ID associated with the assignments.

data.groupIDColumn

string

required

Column name for the group ID linked to the assignments.

data.idTypeMapping

object[]

required

Mappings of Statsig units to their respective columns.

Show child attributes

data.idTypeMapping.statsigUnitID

string

required

ID for the Statsig unit.

data.idTypeMapping.column

string

required

Column name associated with the ID type mapping.

data.isVerified

boolean

Marks the assignment source as verified for internal trustworthiness.

data.isReadOnly

boolean

Specifies if the source can only be edited via the Console API.

data.owner

object

Schema for owner data including ID, type, name. Note that if Entity is created by CONSOLE API, owner will be undefined.

Show child attributes

data.owner.ownerID

string

ID of the owner

Example:

"abc123"

data.owner.ownerType

string

Type of the owner (e.g., SDK_KEY or USER)

Example:

"USER"

data.owner.ownerName

string

The name of the owner. This field is optional.

Example:

"John Doe"

data.owner.ownerEmail

string

The email of the owner. This field is optional.

Example:

{
  "ownerID": "user123",
  "ownerType": "USER",
  "ownerName": "John Doe",
  "ownerEmail": "[email protected]"
}

data.team

string | null

Optional field indicating the team name responsible for the metric, aiding in accountability and management.

data.teamID

string | null

Optional field indicating the team ID responsible for the metric, aiding in accountability and management.

data.scheduledReloadHour

integer<int64> | null

Optional field indicating what UTC hour to run a scheduled scan for the assignment source.

Required range: 0 <= x <= 23

pagination

object

required

Pagination metadata for checking if there is next page for example.

Show child attributes

pagination.itemsPerPage

number<double>

required

pagination.pageNumber

number<double>

required

pagination.nextPage

string | null

required

pagination.previousPage

string | null

required

pagination.totalItems

number<double>

pagination.all

string

Patch Assignment Source

Create Assignment Source

⌘I

SDK Quickstarts

SDK Concepts

Client SDKs

Server SDKs

AI SDKs

More SDK Methods

Console API Reference

Statsig CLI

HTTP API Reference

List Assignment Sources

Authorizations

Headers

Query Parameters

Response