List Assignment Sources

gethttps://statsigapi.net/console/v1/experiments/assignment_sources

Authorizations

STATSIG-API-KEYstringrequired

apiKey (header)

Query parameters

limitinteger

Results per page

pageinteger

Page number

Response

application/json

200List Assignment Sources response

messagestringrequired

A simple string explaining the result of the operation.

dataobject[]required

Show child attributes

name[]stringrequired

Unique identifier for the assignment source.

description[]stringrequired

Detailed context and purpose of the assignment source.

isVerified[]boolean

Marks the assignment source as verified for internal trustworthiness.

tags[]string[]required

Tags for categorization and search.

sql[]stringrequired

SQL query defining the data source for assignments.

timestampColumn[]stringrequired

Column name representing the timestamp of assignments.

experimentIDColumn[]stringrequired

Column name for the experiment ID associated with the assignments.

groupIDColumn[]stringrequired

Column name for the group ID linked to the assignments.

groupNameColumn[]string

Optional column name for the group name linked to the assignments.

idTypeMapping[]object[]required

Mappings of Statsig units to their respective columns.

Show child attributes

statsigUnitID[]stringrequired

ID for the Statsig unit.

column[]stringrequired

Column name associated with the ID type mapping.

isReadOnly[]boolean

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

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

ownerIDstring

ID of the owner

ownerTypestring

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

ownerNamestring

The name of the owner. This field is optional.

ownerEmailstring

The email of the owner. This field is optional.

team[]string

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

teamID[]string

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

scheduledReloadHour[]integer

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

paginationobjectrequired

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

400Invalid request. Please check the request input and try again.

statusintegerrequired

messagestringrequired

401This endpoint only accepts an active CONSOLE key, but an invalid key was sent. Key: console-xxxXXXxxxXXXxxx

statusintegerrequired

messagestringrequired

List Assignment Sources

curl -X GET "https://statsigapi.net/console/v1/experiments/assignment_sources?limit=10&page=1" \
  -H "Content-Type: application/json" \
  -H "STATSIG-API-KEY: YOUR_API_KEY"

Response

{
  "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"
  }
}

Was this helpful?