HTTP API
Console API
Alerts
Audit Logs
Autotunes
Company
Dynamic Configs
- GETList Dynamic Configs
- POSTCreate Dynamic Config
- GETGet Dynamic Config
- POSTFully Update Dynamic Config
- DELDelete Dynamic Config
- PATCHPartially Update Dynamic Config
- PUTDisable Dynamic Config
- PUTEnable Dynamic Config
- POSTAdd Dynamic Config Rule
- GETGet Specific Dynamic Config Rule
- DELDelete Dynamic Config Rule
- PATCHUpdate Dynamic Config Rule By Id
- DELDelete Dynamic Config Rule By Name
- PATCHUpdate Dynamic Config Rule By Name
- GETGet Dynamic Config Rules
- POSTAdd Dynamic Config Rules
- PATCHUpdate List of Dynamic Config Rules
- GETList Dynamic Config Versions
Experiments
- GETList Experiments
- POSTCreate Experiment
- GETGet Experiment
- POSTFully Update Experiment
- DELDeleted Experiment
- PATCHPartially Update Experiment
- PUTAbandon Experiment
- PUTArchive Experiment
- GETRetrieve cumulative exposures
- POSTDisable Experiment Groups
- POSTEnable Experiment Groups
- PUTFinish Experiment Early
- GETGet Experiment Overrides
- POSTUpdate Experiment Overrides
- DELDelete Experiment Overrides
- PATCHPartially Update Experiment Overrides
- GETRetrieve Pulse Results (Beta)
- PUTReset Experiment
- PUTStart Experiment
- PUTUnarchive Experiment
Experiments (Warehouse Native)
- POSTLoad Pulse (Warehouse Native)
- GETPulse Load History (Warehouse Native)
- POSTPost Assignment Source
- DELDelete Assignment Source
- PATCHPatch Assignment Source
- GETList Assignment Sources
- POSTCreate Assignment Source
- GETList Entity Property Sources
- POSTCreate Entity Property Source
- GETGet Entity Property Source
- POSTPost Entity Property Source
- DELDelete Entity Property Source
- PATCHPatch Entity Property Source
Configs
Gates
- GETList Gates
- POSTCreate Gate
- GETRead Gate
- POSTFully Update Gates
- DELDelete Gates
- PATCHPartially Update Gates
- PUTArchive Gate
- PUTDisable Gate
- PUTEnable Gate
- PUTLaunch Gate
- POSTLoad Pulse Gate
- GETGet Gate Override
- POSTUpdate Gate Overrides
- DELDelete Gate Overrides
- PATCHAdd Gate Overrides
- POSTAdd Gate Rule
- GETRead Gate Rules
- POSTAdd Multiple Gate Rule
- PATCHUpdate list of current Gate Rules settings
- DELDelete Gate Rule
- PATCHUpdate Gate Rules
- GETPulse Load History (Warehouse Native)
- GETRetrieve Pulse Results (Beta)
- GETList Gate Versions
Holdouts
Ingestions
- GETRead Ingestion
- POSTCreate Ingestion Source
- DELDelete Ingestion Source
- PATCHUpdate Ingestion Source
- POSTBackfill Ingestion
- POSTCreate Ingestion Databricks
- GETGet Ingestion Event Count
- GETGet Ingestion Event Delta Ledger
- GETList Ingestion Runs
- GETRead Ingestion Run
- GETRead Ingestion Schedule
- POSTUpdate Ingestion Schedule
- GETList Ingestions Status
Keys
Layers
Metrics
Metrics (Warehouse Native)
Project
Reports
Segments
Target App
Users
- GETList Users
- GETGet user by email
- POSTUpdate user
- POSTInvite user. To avoid spamming, invitation emails are not sent. Invitee will see invitation notification in-app after logging in.
- GETList Teams
- POSTCreate Team
- GETGet Team
- DELDelete Team
- PATCHUpdate Team. Ops: Replace. Use GET for current data if you intent to Add.
Gates
Fully Update Gates
POST
/
console
/
v1
/
gates
/
{id}
Copy
Ask AI
curl --request POST \
--url https://statsigapi.net/console/v1/gates/{id} \
--header 'Content-Type: application/json' \
--header 'STATSIG-API-KEY: <api-key>' \
--data '{
"isEnabled": false,
"description": "Updated Gate Description",
"rules": [
{
"name": "All Conditions",
"passPercentage": 10,
"conditions": [
{
"type": "user_id",
"targetValue": [
"111",
"222"
],
"operator": "any"
},
{
"type": "email",
"targetValue": [
"@outlook.com",
"@gmail.com"
],
"operator": "str_contains_any"
},
{
"type": "custom_field",
"targetValue": 31,
"operator": "gt",
"field": "age"
},
{
"type": "app_version",
"targetValue": "1.1.1",
"operator": "version_gt"
},
{
"type": "browser_name",
"targetValue": [
"Android",
"Chrome"
],
"operator": "any"
},
{
"type": "browser_version",
"targetValue": [
"94.0.4606.81",
"94.0.4606.92"
],
"operator": "any"
},
{
"type": "os_name",
"targetValue": [
"Android",
"Windows"
],
"operator": "none"
},
{
"type": "os_version",
"targetValue": "11.0.0",
"operator": "version_lte"
},
{
"type": "country",
"targetValue": [
"NZ",
"US"
],
"operator": "any"
},
{
"type": "environment_tier",
"targetValue": [
"production"
],
"operator": "any"
},
{
"type": "passes_segment",
"targetValue": "growth_org"
},
{
"type": "fails_segment",
"targetValue": "growth_org"
},
{
"type": "ip_address",
"targetValue": [
"1.1.1.1",
"8.8.8.8"
],
"operator": "any"
},
{
"type": "unit_id",
"operator": "any",
"targetValue": [
"31"
],
"customID": "userID"
}
]
}
],
"tags": [
"★ Core"
],
"type": "TEMPORARY",
"idType": "stableID",
"targetApps": []
}'
Copy
Ask AI
{
"data": {
"checksPerHour": 0,
"createdTime": 1705439406615,
"creatorEmail": null,
"creatorID": "4R5PV7mvYdW6NLCwK8ocoz",
"creatorName": "CONSOLE API",
"description": "Updated Gate Description",
"holdoutIDs": [],
"id": "a_gate",
"idType": "stableID",
"isEnabled": false,
"lastModifiedTime": 1705439409750,
"lastModifierEmail": null,
"lastModifierID": "4R5PV7mvYdW6NLCwK8ocoz",
"lastModifierName": "CONSOLE API",
"name": "A Gate",
"rules": [
{
"conditions": [
{
"operator": "any",
"targetValue": [
"111",
"222"
],
"type": "user_id"
},
{
"operator": "str_contains_any",
"targetValue": [
"@outlook.com",
"@gmail.com"
],
"type": "email"
},
{
"field": "age",
"operator": "gt",
"targetValue": 31,
"type": "custom_field"
},
{
"operator": "version_gt",
"targetValue": "1.1.1",
"type": "app_version"
},
{
"operator": "any",
"targetValue": [
"Android",
"Chrome"
],
"type": "browser_name"
},
{
"operator": "any",
"targetValue": [
"94.0.4606.81",
"94.0.4606.92"
],
"type": "browser_version"
},
{
"operator": "none",
"targetValue": [
"Android",
"Windows"
],
"type": "os_name"
},
{
"operator": "version_lte",
"targetValue": "11.0.0",
"type": "os_version"
},
{
"operator": "any",
"targetValue": [
"NZ",
"US"
],
"type": "country"
},
{
"operator": "any",
"targetValue": [
"production"
],
"type": "environment_tier"
},
{
"targetValue": "growth_org",
"type": "passes_segment"
},
{
"targetValue": "growth_org",
"type": "fails_segment"
},
{
"operator": "any",
"targetValue": [
"1.1.1.1",
"8.8.8.8"
],
"type": "ip_address"
},
{
"customID": "userID",
"operator": "any",
"targetValue": [
"31"
],
"type": "unit_id"
}
],
"environments": null,
"name": "All Conditions",
"passPercentage": 10
}
],
"status": "Disabled",
"tags": [
"★ Core"
],
"targetApps": [],
"type": "PERMANENT",
"typeReason": "NONE",
"team": null,
"reviewSettings": {
"requiredReview": false,
"allowedReviewers": []
},
"measureMetricLifts": true,
"owner": {
"ownerID": "user123",
"ownerName": "CONSOLE API",
"ownerType": "SDK_KEY",
"ownerEmail": ""
},
"monitoringMetrics": []
},
"message": "Gate updated successfully."
}
Authorizations
Headers
Optional header to respect review settings for mutation endpoints.
Path Parameters
id
Body
application/json
Response
200 - application/json
Update gate response
The response is of type object
.
Copy
Ask AI
curl --request POST \
--url https://statsigapi.net/console/v1/gates/{id} \
--header 'Content-Type: application/json' \
--header 'STATSIG-API-KEY: <api-key>' \
--data '{
"isEnabled": false,
"description": "Updated Gate Description",
"rules": [
{
"name": "All Conditions",
"passPercentage": 10,
"conditions": [
{
"type": "user_id",
"targetValue": [
"111",
"222"
],
"operator": "any"
},
{
"type": "email",
"targetValue": [
"@outlook.com",
"@gmail.com"
],
"operator": "str_contains_any"
},
{
"type": "custom_field",
"targetValue": 31,
"operator": "gt",
"field": "age"
},
{
"type": "app_version",
"targetValue": "1.1.1",
"operator": "version_gt"
},
{
"type": "browser_name",
"targetValue": [
"Android",
"Chrome"
],
"operator": "any"
},
{
"type": "browser_version",
"targetValue": [
"94.0.4606.81",
"94.0.4606.92"
],
"operator": "any"
},
{
"type": "os_name",
"targetValue": [
"Android",
"Windows"
],
"operator": "none"
},
{
"type": "os_version",
"targetValue": "11.0.0",
"operator": "version_lte"
},
{
"type": "country",
"targetValue": [
"NZ",
"US"
],
"operator": "any"
},
{
"type": "environment_tier",
"targetValue": [
"production"
],
"operator": "any"
},
{
"type": "passes_segment",
"targetValue": "growth_org"
},
{
"type": "fails_segment",
"targetValue": "growth_org"
},
{
"type": "ip_address",
"targetValue": [
"1.1.1.1",
"8.8.8.8"
],
"operator": "any"
},
{
"type": "unit_id",
"operator": "any",
"targetValue": [
"31"
],
"customID": "userID"
}
]
}
],
"tags": [
"★ Core"
],
"type": "TEMPORARY",
"idType": "stableID",
"targetApps": []
}'
Copy
Ask AI
{
"data": {
"checksPerHour": 0,
"createdTime": 1705439406615,
"creatorEmail": null,
"creatorID": "4R5PV7mvYdW6NLCwK8ocoz",
"creatorName": "CONSOLE API",
"description": "Updated Gate Description",
"holdoutIDs": [],
"id": "a_gate",
"idType": "stableID",
"isEnabled": false,
"lastModifiedTime": 1705439409750,
"lastModifierEmail": null,
"lastModifierID": "4R5PV7mvYdW6NLCwK8ocoz",
"lastModifierName": "CONSOLE API",
"name": "A Gate",
"rules": [
{
"conditions": [
{
"operator": "any",
"targetValue": [
"111",
"222"
],
"type": "user_id"
},
{
"operator": "str_contains_any",
"targetValue": [
"@outlook.com",
"@gmail.com"
],
"type": "email"
},
{
"field": "age",
"operator": "gt",
"targetValue": 31,
"type": "custom_field"
},
{
"operator": "version_gt",
"targetValue": "1.1.1",
"type": "app_version"
},
{
"operator": "any",
"targetValue": [
"Android",
"Chrome"
],
"type": "browser_name"
},
{
"operator": "any",
"targetValue": [
"94.0.4606.81",
"94.0.4606.92"
],
"type": "browser_version"
},
{
"operator": "none",
"targetValue": [
"Android",
"Windows"
],
"type": "os_name"
},
{
"operator": "version_lte",
"targetValue": "11.0.0",
"type": "os_version"
},
{
"operator": "any",
"targetValue": [
"NZ",
"US"
],
"type": "country"
},
{
"operator": "any",
"targetValue": [
"production"
],
"type": "environment_tier"
},
{
"targetValue": "growth_org",
"type": "passes_segment"
},
{
"targetValue": "growth_org",
"type": "fails_segment"
},
{
"operator": "any",
"targetValue": [
"1.1.1.1",
"8.8.8.8"
],
"type": "ip_address"
},
{
"customID": "userID",
"operator": "any",
"targetValue": [
"31"
],
"type": "unit_id"
}
],
"environments": null,
"name": "All Conditions",
"passPercentage": 10
}
],
"status": "Disabled",
"tags": [
"★ Core"
],
"targetApps": [],
"type": "PERMANENT",
"typeReason": "NONE",
"team": null,
"reviewSettings": {
"requiredReview": false,
"allowedReviewers": []
},
"measureMetricLifts": true,
"owner": {
"ownerID": "user123",
"ownerName": "CONSOLE API",
"ownerType": "SDK_KEY",
"ownerEmail": ""
},
"monitoringMetrics": []
},
"message": "Gate updated successfully."
}
Assistant
Responses are generated using AI and may contain mistakes.