List Dynamic Config References
https://statsigapi.net/console/v1/gates/{id}/dynamic_config_referencesAuthorizations
STATSIG-API-KEYstringrequiredapiKey (header)
Path parameters
idstringrequiredid
Query parameters
pageintegerPage number
limitnumberResponse
application/jsonmessagestringrequiredA simple string explaining the result of the operation.
dataobject[]requiredShow child attributes
id[]stringrequiredID
name[]stringOptional name for the configuration.
idType[]stringThe type of ID which the dynamic config is based on.
description[]stringrequiredA brief summary of what the dynamic config is being used for
lastModifierID[]stringrequiredID of the last modifier.
lastModifiedTime[]numberrequiredTime of the last modification.
lastModifierEmail[]stringrequiredEmail of the last modifier.
lastModifierName[]stringrequiredName of the last modifier.
creatorID[]stringcreatedTime[]numberrequiredTimestamp when the entity was created.
creatorName[]stringrequiredName of the creator.
creatorEmail[]stringtags[]string[]The list of tag names attached to the dynamic config
targetApps[]oneOfholdoutIDs[]string[]Holdouts applied to this configuration.
team[]stringThe team name associated with the dynamic config, Enterprise only.
teamID[]stringThe team ID associated with the dynamic config, Enterprise only.
version[]numberVersion number
isEnabled[]booleanrequiredIs the dynamic config enabled
rules[]object[]requiredAn array of Rule objects
name[]stringrequiredThe name of this rule.
passPercentage[]numberrequiredOf the users that meet the conditions of this rule, what percent should return true.
conditions[]object[]requiredAn array of Condition objects.
targetValue[]oneOfoperator[]stringfield[]stringcustomID[]stringtype[]stringrequiredenvironments[]string[]id[]stringThe Statsig ID of this rule.
baseID[]stringThe base ID of this rule, i.e. without any added metadata. Will remain the exact same throughout
returnValue[]objectcompletedAutomatedRollouts[]object[]Read-only: Automated rollout phases that have already completed.
time[]numberpassPercent[]numberrequiredpendingAutomatedRollouts[]object[]Read-only: Automated rollout phases that are scheduled but not yet complete.
time[]numberpassPercent[]numberrequiredreturnValueJson5[]stringvariants[]object[]id[]stringname[]stringrequiredpassPercentage[]numberrequiredreturnValue[]objectreturnValueJson5[]stringdefaultValue[]objectThe fallback JSON object when no rules are triggered
defaultValueJson5[]stringCan include comments. If provided with defaultValue, must parse to the same JSON
owner[]objectSchema for owner data including ID, type, name. Note that if Entity is created by CONSOLE API, owner will be undefined.
ownerIDstringID of the owner
ownerTypestringType of the owner (e.g., SDK_KEY or USER)
ownerNamestringThe name of the owner. This field is optional.
ownerEmailstringThe email of the owner. This field is optional.
schema[]stringA schema using JSON Schema Draft 2020-12 to enforce return values of this dynamic config's rules.
schemaJson5[]stringschema except with Json5 comments. Optional and should parse to same json as schema.
releasePipelineID[]stringThe release pipeline ID associated with the dynamic config
isTemplate[]booleanstatus[]stringchecksPerHour[]numberpermalink[]stringrequiredA permalink to this dynamic config in the Statsig Console.
type[]stringrequiredThe lifecycle type of the config (TEMPORARY, PERMANENT, or STALE). STALE classification depends on the nightly stale detection batch job having run; a config not yet processed reads as TEMPORARY.
typeReason[]stringrequiredThe reason for the current type classification. Depends on the nightly stale detection batch job having run.
isPermanent[]booleanrequiredWhether the config has been explicitly marked as long-lived.
paginationobjectrequiredPagination metadata for checking if there is next page for example.
statusintegerrequiredmessagestringrequiredWas this helpful?