Get Dynamic Config Rules

GET /console/v1/dynamic_configs/{id}/rules

Try it

Get Dynamic Config Rules

cURL

curl --request GET \
  --url https://statsigapi.net/console/v1/dynamic_configs/{id}/rules \
  --header 'STATSIG-API-KEY: <api-key>'

200

{
  "message": "Dynamic Config rules read successfully.",
  "data": [
    {
      "rules": [
        {
          "id": "5pjzfmF8KLFsh81kBPyxvR",
          "baseID": "5pjzfmF8KLFsh81kBPyxvR",
          "name": "rule name",
          "passPercentage": 1,
          "conditions": [
            {
              "type": "browser_name",
              "targetValue": [],
              "operator": "any"
            }
          ],
          "environments": null
        },
        {
          "id": "6jQEnu1fCnXqjXhm1qGEnt",
          "baseID": "6jQEnu1fCnXqjXhm1qGEnt",
          "name": "Other2",
          "passPercentage": 80,
          "conditions": [],
          "environments": null
        },
        {
          "id": "4DonExIcOjSV8kG3WSQ5Zm",
          "baseID": "4DonExIcOjSV8kG3WSQ5Zm",
          "name": "Austin's fav rule",
          "passPercentage": 8,
          "conditions": [],
          "environments": null
        }
      ]
    }
  ],
  "pagination": {
    "itemsPerPage": 20000,
    "pageNumber": 1,
    "totalItems": 1,
    "nextPage": null,
    "previousPage": null,
    "all": ""
  }
}

Authorizations

STATSIG-API-KEY · string · header · required

Headers

x-respect-review-settings · string

Optional header to respect review settings for mutation endpoints.

Path Parameters

id · string · required

id

Response

200 - application/json

Get Dynamic Config Rules Response

message · string · required

A simple string explaining the result of the operation.

data · object[] · required

Array of results returned by pagination limit.

Show child attributes

data. rules · object[] · required

Show child attributes

data.rules. name · string · required

The name of this rule.

data.rules. passPercentage · number · required

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

Required range: 0 <= x <= 100Must be a multiple of 0.01

data.rules. conditions · object[] · required

An array of Condition objects.

Show child attributes

data.rules.conditions. type · enum<string> · required

Available options: 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

data.rules.conditions. targetValue

data.rules.conditions. operator · string

data.rules.conditions. field · string | null

data.rules.conditions. customID · string | null

data.rules. environments · string[] | null

The environments this rule is enabled for.

data.rules. id · string

The Statsig ID of this rule.

data.rules. baseID · string

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

data.rules. returnValue · object

The return value of the rule.

Show child attributes

data.rules.returnValue. {key} · any

pagination · object · required

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

Show child attributes

pagination. itemsPerPage · number · required

pagination. pageNumber · number · required

pagination. nextPage · string | null · required

pagination. previousPage · string | null · required

pagination. totalItems · number

pagination. all · string