For AI agents: a documentation index is available at /llms.txt. Append .md to any page URL for markdown, or send Accept: text/markdown.

Get Dynamic Config Rules

Get Dynamic Config Rules

gethttps://statsigapi.net/console/v1/dynamic_configs/{id}/rules

Authorizations

STATSIG-API-KEYstringrequired

apiKey (header)

Path parameters

idstringrequired

id

Response

application/json
200· Get Dynamic Config Rules Response
messagestringrequired

A simple string explaining the result of the operation.

dataobject[]required
Show child attributes
rulesobject[]required
namestringrequired

The name of this rule.

passPercentagenumberrequired

Of the users that meet the conditions of this rule, what percent should return true.

Constraints:min: 0max: 100
conditionsobject[]required

An array of Condition objects.

targetValueoneOf
Constraints:nullablestring[]number[]stringnumber
operatorstring
Allowed values:anynoneany_case_sensitivenone_case_sensitivestr_contains_anystr_contains_nonegtltltegteversion_gtversion_ltversion_gteversion_lteversion_eqafterbeforeonis_nullis_not_nullstr_matchesencoded_anyarray_contains_anyarray_contains_nonearray_contains_allnot_array_contains_all
fieldstring
Constraints:nullable
customIDstring
Constraints:nullable
typestringrequired
Allowed values:app_versionbrowser_namebrowser_versioncountrycustom_fieldemailenvironment_tierfails_gatefails_segmentip_addresslocaleos_nameos_versionpasses_gatepasses_segmentpublictimeunit_iduser_iduser_agenturljavascriptdevice_modeltarget_appexperiment_group
environmentsstring[]

The environments this rule is enabled for.

Constraints:nullable
idstring

The Statsig ID of this rule.

baseIDstring

The base ID of this rule, i.e. without any added metadata. Will remain the exact same throughout

returnValueobject

The return value of the rule.

completedAutomatedRolloutsobject[]

Read-only: Automated rollout phases that have already completed.

timenumber
passPercentnumberrequired
phaseDurationMsinteger
Constraints:min: 0
pendingAutomatedRolloutsobject[]

Automated rollout phases that are scheduled but not yet complete. Writable on create/update; also returned on read. time is an epoch-seconds timestamp and is required unless phaseDurationMs is set. phaseDurationMs schedules the phase relative to the previous one. A time in the past is accepted so a read-modify-write round trip succeeds; that phase advances on the next automated rollout run.

timenumber
passPercentnumberrequired
phaseDurationMsinteger
Constraints:min: 0
safeguardobject

Safeguard configuration for automated rollback/pause actions when linked alerts fire.

Constraints:nullable
alertActionstringrequired
Allowed values:rollback_to_0rollout_to_100pause
guardrailAlertsstring[]required
toplineAlertsstring[]
Constraints:nullable
toplineEvaluationPeriodInMsoneOf
Constraints:number (nullable, min: 0)number
manualEvaluationRenewalTimeInMsinteger
Constraints:nullable
paginationobjectrequired

Pagination metadata for checking if there is next page for example.

Show child attributes
itemsPerPagenumberrequired
Constraints:format: double
pageNumbernumberrequired
Constraints:format: double
nextPagestringrequired
Constraints:nullable
previousPagestringrequired
Constraints:nullable
totalItemsnumber
Constraints:format: double
allstring

Was this helpful?