Create a Layer

POST /console/v1/layers

Try it

Create a Layer

cURL

curl --request POST \
  --url https://statsigapi.net/console/v1/layers \
  --header 'Content-Type: application/json' \
  --header 'STATSIG-API-KEY: <api-key>' \
  --data '
{
  "name": "<string>",
  "idType": "<string>",
  "description": "<string>",
  "targetApps": "<string>",
  "team": "<string>"
}
'

201

{
  "message": "Layer created successfully.",
  "data": {
    "id": "the_best_layer",
    "description": "helpful summary of what this layer does",
    "idType": "userID",
    "lastModifierID": "4dcQUIpS8PHObBGD7HJwOx",
    "lastModifiedTime": 1720733945538,
    "lastModifierName": "CONSOLE API",
    "lastModifierEmail": null,
    "creatorID": "4dcQUIpS8PHObBGD7HJwOx",
    "createdTime": 1720733942515,
    "creatorName": "CONSOLE API",
    "creatorEmail": null,
    "targetApps": [
      "Android"
    ],
    "holdoutIDs": [
      "global_holdout",
      "test_holdout"
    ],
    "tags": [],
    "team": "Console Team",
    "isImplicitLayer": false,
    "parameters": []
  }
}

Authorizations

STATSIG-API-KEY · string · header · required

Headers

x-respect-review-settings · string

Optional header to respect review settings for mutation endpoints.

Body

application/json

name · string · required

The unique name of the layer, formatted as an ID (e.g., "A Layer" becomes "a_layer").

Required string length: 3 - 100

idType · string · required

The type of ID used for this layer, essential for validation in services.

description · string

A helpful description of what this layer does, providing context for its purpose.

Maximum string length: 1000

targetApps

List of target applications that this layer is associated with.

team · string

Optional identifier for the team responsible for this layer.

Response

201

application/json

Create Layer Response

message · string · required

A simple string explaining the result of the operation.

data · object · required

A single result.

Show child attributes

data. id · string · required

ID

data. idType · string · required

The ID type used for this layer, important for validation.

data. description · string · required

A detailed description of the layer, explaining its purpose and functionality.

Maximum string length: 1000

data. lastModifierID · string | null · required

ID of the last modifier.

data. lastModifiedTime · number | null · required

Time of the last modification.

data. lastModifierEmail · string | null · required

Email of the last modifier.

data. lastModifierName · string | null · required

Name of the last modifier.

data. creatorID · string | null · required

ID of the user who created the entity.

data. createdTime · number · required

Timestamp when the entity was created.

data. creatorName · string | null · required

Name of the creator.

data. creatorEmail · string | null · required

Email of the creator.

data. isImplicitLayer · boolean · required

Indicates if the layer was automatically created by Statsig during experiment creation.

data. parameters · object[] · required

An array of parameters associated with the layer, each defining specific attributes.

Show child attributes

data.parameters. name · string · required

The name of this parameter, used for identification within the layer.

data.parameters. type · enum<string> · required

The data type that this parameter returns. Allowed types include: string, boolean, number, object, and array.

Available options: string, number, boolean, object, array

data.parameters. defaultValue · required

The default value for this parameter, which must match the specified type.

data. name · string

Optional name for the configuration.

data. tags · string[]

Optional tags for categorization.

data. targetApps

List of target applications that this layer is intended for.

data. holdoutIDs · string[]

Holdouts applied to this configuration.

data. team · string | null

Optional name for the responsible team.

data. teamID · string | null

Optional ID of the responsible team.

data. version · number

Version number