Ingestions
Create Ingestion Source
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.
Ingestions
Create Ingestion Source
POST
/
console
/
v1
/
ingestion
curl --request POST \
--url https://statsigapi.net/console/v1/ingestion \
--header 'Content-Type: application/json' \
--header 'STATSIG-API-KEY: <api-key>' \
--data '{
"dataset": "Metrics",
"column_mapping": {
"unit_id": "<string>",
"id_type": "<string>",
"dateid": "<string>",
"metric_name": "<string>",
"metric_value": "null",
"numerator": "null",
"denominator": "null"
},
"type": "redshift",
"source_name": "<string>",
"query": "<string>",
"use_delta_sharing": true,
"share": "<string>",
"schema": "<string>",
"table": "<string>",
"enabled": true
}'{
"type": "databricks",
"dataset": "Metrics",
"source_name": "ingestion-1",
"query": "SELECT * FROM TABLE",
"column_mapping": {
"unit_id": "string",
"id_type": "string",
"dateid": "string",
"metric_name": "string",
"metric_value": "string",
"numerator": "string",
"denominator": "string"
},
"use_delta_sharing": false,
"share": "string",
"schema": "string",
"table": "string",
"enabled": false
}Authorizations
Headers
Optional header to respect review settings for mutation endpoints.
Body
application/json
Available options:
Metrics Available options:
redshift, bigquery-v2, snowflake-v2, databricks, azure-synapse, s3, athena, adls The unique user identifier this metric is for. This might not necessarily be a user_id - it could be a custom_id of some kind. Make sure this is in the same format as your logged unit_ids.
The id_type the unit_id represents. Must be valid id_type. Default Statsig types are user_id/stable_id, but you may have generated custom id_types. Make sure this matches (case sensitive) a customID in your project, or you won’t get experiment results.
Date of the daily metric, ISO formatted (ex. 2021-02-17). We’ll load custom metrics to whatever date you use here.
String format. Not null. Length < 128 characters.
Numeric value for the metric. This OR both of numerator and denominator need to be provided.
Required for ratio metrics. If present along with a denominator in any record, the metric will be treated as ratio and only calculated for users with non-null denominators
Required for ratio metrics. If present along with a numerator in any record, the metric will be treated as ratio and only calculated for users with non-null numerators.
curl --request POST \
--url https://statsigapi.net/console/v1/ingestion \
--header 'Content-Type: application/json' \
--header 'STATSIG-API-KEY: <api-key>' \
--data '{
"dataset": "Metrics",
"column_mapping": {
"unit_id": "<string>",
"id_type": "<string>",
"dateid": "<string>",
"metric_name": "<string>",
"metric_value": "null",
"numerator": "null",
"denominator": "null"
},
"type": "redshift",
"source_name": "<string>",
"query": "<string>",
"use_delta_sharing": true,
"share": "<string>",
"schema": "<string>",
"table": "<string>",
"enabled": true
}'{
"type": "databricks",
"dataset": "Metrics",
"source_name": "ingestion-1",
"query": "SELECT * FROM TABLE",
"column_mapping": {
"unit_id": "string",
"id_type": "string",
"dateid": "string",
"metric_name": "string",
"metric_value": "string",
"numerator": "string",
"denominator": "string"
},
"use_delta_sharing": false,
"share": "string",
"schema": "string",
"table": "string",
"enabled": false
}