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.
Create Segment
curl --request POST \
--url https://statsigapi.net/console/v1/segments \
--header 'Content-Type: application/json' \
--header 'STATSIG-API-KEY: <api-key>' \
--data '{
"name": "<string>",
"id": "<string>",
"description": "<string>",
"type": "id_list",
"idType": "userID",
"tags": [
"<string>"
],
"creatorID": "<string>",
"creatorEmail": "<string>",
"team": "<string>",
"teamID": "<string>",
"rules": [
{
"name": "<string>",
"passPercentage": 50,
"conditions": [
{
"targetValue": [
"<string>"
],
"operator": "<string>",
"field": "<string>",
"customID": "<string>",
"type": "app_version"
}
],
"environments": [
"<string>"
],
"id": "<string>",
"baseID": "<string>",
"returnValue": {}
}
]
}'{
"message": "Segment created successfully.",
"data": {
"id": "an_id_list",
"isEnabled": true,
"description": "helpful summary of what this segment is",
"lastModifierName": "CONSOLE API",
"lastModifierID": "ahKwUoaNauHu9AmJPc2",
"type": "id_list",
"count": 0,
"tags": [
"a tag"
]
}
}Authorizations
Headers
Optional header to respect review settings for mutation endpoints.
Body
name of the segment
3 - 100type of the segment
id_list, rule_based, analysis_list optional id of the segment (defaults to name)
3 - 100description of the segment
1000type of id
optional tags for categorization
the Statsig ID of the creator of this experiment
the email of the creator of this experiment
optional name identifier for the responsible team (enterprise only)
optional identifier for the responsible team (enterprise only)
Rule Object
The name of this rule.
Of the users that meet the conditions of this rule, what percent should return true.
0 <= x <= 100Must be a multiple of 0.01app_version, browser_name, browser_version, country, custom_field, email, environment_tier, fails_segment, ip_address, os_name, os_version, passes_segment, unit_id, user_id The environments this rule is enabled for.
The Statsig ID of this rule.
The base ID of this rule, i.e. without any added metadata. Will remain the exact same throughout
Response
A simple string explaining the result of the operation.
A single result.
Is the segment enabled.
id_list, rule_based, analysis_list ID
Type of ID
Detailed description of the configuration’s purpose.
ID of the last modifier.
Time of the last modification.
Email of the last modifier.
Name of the last modifier.
ID of the user who created the entity.
Timestamp when the entity was created.
Name of the creator.
Email of the creator.
For id_list segments: the length of the ID list
Rule Object
The name of this rule.
Of the users that meet the conditions of this rule, what percent should return true.
0 <= x <= 100Must be a multiple of 0.01An array of Condition objects.
app_version, browser_name, browser_version, country, custom_field, email, environment_tier, fails_gate, fails_segment, ip_address, locale, os_name, os_version, passes_gate, passes_segment, public, time, unit_id, user_id, url, javascript, device_model, target_app The environments this rule is enabled for.
The Statsig ID of this rule.
The base ID of this rule, i.e. without any added metadata. Will remain the exact same throughout
Optional tags for categorization.
Optional name for the configuration.
List of target applications associated with this configuration.
Holdouts applied to this configuration.
Optional name for the responsible team.
Optional ID of the responsible team.
Version number
curl --request POST \
--url https://statsigapi.net/console/v1/segments \
--header 'Content-Type: application/json' \
--header 'STATSIG-API-KEY: <api-key>' \
--data '{
"name": "<string>",
"id": "<string>",
"description": "<string>",
"type": "id_list",
"idType": "userID",
"tags": [
"<string>"
],
"creatorID": "<string>",
"creatorEmail": "<string>",
"team": "<string>",
"teamID": "<string>",
"rules": [
{
"name": "<string>",
"passPercentage": 50,
"conditions": [
{
"targetValue": [
"<string>"
],
"operator": "<string>",
"field": "<string>",
"customID": "<string>",
"type": "app_version"
}
],
"environments": [
"<string>"
],
"id": "<string>",
"baseID": "<string>",
"returnValue": {}
}
]
}'{
"message": "Segment created successfully.",
"data": {
"id": "an_id_list",
"isEnabled": true,
"description": "helpful summary of what this segment is",
"lastModifierName": "CONSOLE API",
"lastModifierID": "ahKwUoaNauHu9AmJPc2",
"type": "id_list",
"count": 0,
"tags": [
"a tag"
]
}
}