v2

latestOpenAPI 3.0.02026-08-073221853.1 MB

Experiments

Experiments (Warehouse Native)

Patch Assignment Source

patch/console/v1/experiments/assignment_source/{name}

Path parameters

namestring required

Name of the assignment source

Request body

namestring

Unique identifier for the assignment source.

descriptionstring

Detailed context and purpose of the assignment source.

isVerifiedboolean

Marks the assignment source as verified for internal trustworthiness.

tagsstring[]

Tags for categorization and search.

{"stackTrail":"components:schemas:AssignmentSourcePartialUpdateDto:properties:sql","oasType":"schema","type":"unknown","description":"SQL query defining the data source for assignments."}

timestampColumnstring

Column name representing the timestamp of assignments.

experimentIDColumnstring

Column name for the experiment ID associated with the assignments.

groupIDColumnstring

Column name for the group ID linked to the assignments.

groupNameColumnstring

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

isReadOnlyboolean

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

teamstring nullable

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

teamIDstring nullable

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

scheduledReloadHourinteger nullable

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

dryRunboolean

Skips persisting the assignment source (used to validate that inputs are correct)

Example request

{
  "owner": {
    "ownerID": "user123",
    "ownerType": "USER",
    "ownerName": "John Doe",
    "ownerEmail": "owner123@test.com"
  }
}

Response

Patch Assignment Source response

messagestring required

A simple string explaining the result of the operation.

Example response

{
  "message": "Assignment Source updated successfully",
  "data": {
    "name": "exposures3",
    "description": "qweqwe",
    "tags": [],
    "sql": "SELECT * FROM shoppy-sales.experiment_data.exposures",
    "timestampColumn": "ts",
    "groupIDColumn": "group_id",
    "experimentIDColumn": "experiment_name",
    "idTypeMapping": [
      {
        "statsigUnitID": "stableID",
        "column": "user_id"
      }
    ]
  }
}