Fetch the Rule for a Ruleset in an Environment

1 min

GET

https://api.optimizely.com/flags/v1//projects/{project_id}/flags/{flag_key}/environments/{environment_key}/rules/{rule_key}

Fetch a Rule for a Ruleset in a specific Environment of a project.

Path Parameters

project_idintegerrequired
Example
12345
Description
The project identifier
flag_keystringrequired
Example
recurring_deposit
Description
The Flag identifier
environment_keystringrequired
Example
production
Description
The Environment identifier
rule_keystringrequired
Example
rule_key
Description
The Rule identifier

Responses

200Successful retrieval of a Rule.

Rule
Description
Configuration which contains audiences, metrics and variations.
- allow_listmap<string, RuleAllowList>
  Description
  User and Variation to force in the experiment
- archivedboolean
  Description
  Indicates if the rule is archived or not.
  Default
  false
- audience_conditionsobject[]
  Example
  ["["or",{"audience_id":5340810295}]"]
  Description
  The audiences that should see this rule. To target everyone, use the string "everyone" or omit this field. Multiple audiences can be combined with "and" or "or" using the same structure as audience conditions.
- baseline_variation_idinteger
  Description
  The id of the baseline variation, the original version of an experiment(e.g. control group) against which variations are compared.
- commentstring
  Description
  comment on conclusion of rule.
- created_timestring<date-time>
  Example
  2019-05-08T00:00:00.000Z
  Description
  Timestamp when the Rule is created
  Format
  date-time
- custom_fieldsmap<string, string>
  Description
  Custom field values for this rule, keyed by custom field key.
- deployed_td_rule_audience_conditionsobject[]
  Example
  ["["or",{"audience_id":5340810295}]"]
  Description
  The audiences that should see this deployed Targeted delivery rule.
- deployed_td_rule_keystring
  Description
  deployed_td_rule_key on conclusion of rule.
- deployed_td_rule_percentage_includedinteger
  Description
  The percentage of the designated audiences that should get the new targeted delevery rule, measured in basis points. 100 basis points = 1% traffic
  Default
  0
  Minimum
  0
  Maximum
  10000
- deployed_variation_keystring
  Description
  deployed_variation_key on conclusion of rule.
- descriptionstring
  Example
  This rule is used for delivery an experience to paid users
  Description
  Additional context of the Rule
- distribution_modestring<manual | stats_accelerator>
  Description
  Type of rule distribution. Only a/b experiment can show distribution_mode field in the response
  Allowed
  manualstats_accelerator
- enabledboolean
  Description
  Indicates if the rule is enabled or not in an environment.
  Default
  true
- environment_keystring
  Description
  User-facing Environment identifier
- environment_namestring
  Description
  The name of the Environment
- fetch_results_ui_urlobject
  Description
  A url to be used to find a particular Results page. This field is optional and returned only if rule has results
  - UrlValue
- flag_keystring
  Description
  User-facing Unique identifier of the Flag.
- flag_namestring
  Description
  The name of the Flag
- group_idstring
  Description
  Group id
- group_remaining_traffic_allocationinteger
  Description
  Total remaining traffic allocation of the mutual exclusion group that this rule is in. This field is returned only if rule is has mutex group and user has mutex permissions
- group_ruleRuleGroupRule
  Example
```
{
  "id": 73915,
  "name": "My Group",
  "traffic_allocation": 5000
}
```
  Description
  The Group information of this rule belongs to. This field is returned only if rule is has mutex group and user has mutex permissions
  - group_idintegerrequired
    Description
    Group id
  - group_namestring
    Description
    Name of the Group
  - traffic_allocationinteger
    Description
    The traffic allocation for the GroupRule
    Minimum
    0
    Maximum
    10000
- hypothesisstring
  Description
  Experiment hypothesis text
  Max Length
  1000
- idinteger
  Example
  45633994
- keystringrequired
  Example
  paid_users
- layer_experiment_idinteger
  Example
  9000000013579
- layer_idinteger
  Example
  9000000013569
- metricsMetric[]
  Description
  List of metrics that are evaluated for the decision rules.
  - aggregatorstring<unique | count | sum | ratio>required
    Description
    The aggregation function for the numerator of the metric. 'unique' measures the number of unique visitors/sessions that include the specified Event. 'count' measures the total number of occurrences of Event for the scope (visitor/session). 'sum' is the sum of the 'field' value
    Allowed
    uniquecountsumratio
  - display_titlestring
    Description
    An optional title for the unique metric configuration. If not provided, the event name will be used.
  - display_unitstring
    Description
    An optional name for the unit of the unique metric configuration.
  - event_idinteger<int64>
    Example
    32334454244
    Description
    The ID for the Event to select data from. Omitted for global metrics that are not relative to a specific Event, i.e. "overall revenue"
    Format
    int64
  - event_propertiesobject
    - filterobject
      - combine_operatorstring<or | and>
        Allowed
        orand
      - conditionsEventPropertyCondition[]
        namestringrequired
        operatorstring<equal_to | not_equal_to | greater_than | greater_than_or_equal_to | less_than | less_than_or_equal_to | contains | does_not_contain>required
        Allowed
        equal_tonot_equal_togreater_thangreater_than_or_equal_toless_thanless_than_or_equal_tocontainsdoes_not_contain
        typestring<string | number | boolean>required
        Allowed
        stringnumberboolean
        valuestringrequired
  - event_typestring
  - fieldstring<revenue | value>
    Description
    The field to aggregate for the numerator of the metric. Required when 'aggregator' = 'sum', otherwise omitted
    Allowed
    revenuevalue
  - idstring
    Description
    A unique identifier for the metric configuration.
  - metricsSubMetric[]
    - aggregatorstring
    - display_titlestring
    - event_idinteger
    - event_typestring
    - fieldstring
    - rolestring<numerator | denominator>
      Allowed
      numeratordenominator
    - scopestring
  - project_idinteger
    Description
    A unique identifier for the project associated with the metric.
  - scopestring<session | visitor | event>
    Description
    Specifies how Events should be grouped together. Can also be thought of as the denonimator of the metric. 'session' divides by the number of sessions. "Influenced sessions", or sessions that do not contain a decision Event but carry a decision from a previous session are not included in counts for numerator or denominator. 'visitor' divides by the number of visitors. 'event' divides by the total occurrences (impressions) of the specified Event
    Allowed
    sessionvisitorevent
  - visibilitystring<account | experiment | project>
    Description
    The visibility of the metric.
    Allowed
    accountexperimentproject
  - winning_directionstring<increasing | decreasing>required
    Description
    The winning direction of this metric
    Allowed
    increasingdecreasing
- namestringrequired
  Example
  Paid Users
- outcomestring<positive | negative | inconclusive>
  Description
  outcome of rule.
  Allowed
  positivenegativeinconclusive
- percentage_includedinteger
  Description
  The percentage of the designated audiences that should get the decision rule, measured in basis points. 100 basis points = 1% traffic
  Default
  0
  Minimum
  0
  Maximum
  10000
- statusstring<draft | running | paused | concluded>
  Description
  status of rule. Status will change to 'Running' when Ruleset is 'Running'.
  Allowed
  draftrunningpausedconcluded
- test_plan_namestring
  Description
  Test plan reference text or uploaded file name
  Max Length
  255
- test_plan_typestring<url | file>
  Description
  Type of test plan attachment
  Allowed
  urlfile
- test_plan_urlstring
  Description
  Test plan URL (external) or backend proxy path (file)
  Max Length
  2000
- typestring<targeted_delivery | a/b | multi_armed_bandit | feature_rollout>required
  Description
  Type of rule.
  Allowed
  targeted_deliverya/bmulti_armed_banditfeature_rollout
- updated_timestring<date-time>
  Example
  2019-05-08T00:00:00.000Z
  Description
  Timestamp when the Rule is updated
  Format
  date-time
- urnstring
  Example
  rules.flags.optimizely.com::45633910
  Description
  The URN for the Rule
- variationsmap<string, RuleVariation>
  Description
  Map of variations by variation key.

400Malformed requests and invalid parameter names and types

401Invalid credentials

403Do not have permission to perform the operation

404Not found. No content

curl

curl --request GET \
     --url https://api.optimizely.com/flags/v1//projects/{project_id}/flags/{flag_key}/environments/{environment_key}/rules/{rule_key} \
     --header 'accept: application/json'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var requestOptions = {
   method: 'GET',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("https://api.optimizely.com/flags/v1//projects/{project_id}/flags/{flag_key}/environments/{environment_key}/rules/{rule_key}", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://api.optimizely.com/flags/v1//projects/{project_id}/flags/{flag_key}/environments/{environment_key}/rules/{rule_key}")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://api.optimizely.com/flags/v1//projects/{project_id}/flags/{flag_key}/environments/{environment_key}/rules/{rule_key}"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

200

// Successful retrieval of a Rule.
{
  "allow_list": "",
  "archived": false,
  "audience_conditions": [
    {}
  ],
  "baseline_variation_id": 0,
  "comment": "",
  "created_time": "2019-05-08T00:00:00.000Z",
  "custom_fields": "",
  "deployed_td_rule_audience_conditions": [
    {}
  ],
  "deployed_td_rule_key": "",
  "deployed_td_rule_percentage_included": 0,
  "deployed_variation_key": "",
  "description": "This rule is used for delivery an experience to paid users",
  "distribution_mode": "",
  "enabled": false,
  "environment_key": "",
  "environment_name": "",
  "fetch_results_ui_url": {},
  "flag_key": "",
  "flag_name": "",
  "group_id": "",
  "group_remaining_traffic_allocation": 0,
  "group_rule": {
    "group_id": 0,
    "group_name": "",
    "traffic_allocation": 0
  },
  "hypothesis": "",
  "id": 45633994,
  "key": "paid_users",
  "layer_experiment_id": 9000000013579,
  "layer_id": 9000000013569,
  "metrics": [
    {
      "aggregator": "",
      "display_title": "",
      "display_unit": "",
      "event_id": 32334454244,
      "event_properties": {
        "filter": {
          "combine_operator": "",
          "conditions": [
            {
              "name": "",
              "operator": "",
              "type": "",
              "value": ""
            }
          ]
        }
      },
      "event_type": "",
      "field": "",
      "id": "",
      "metrics": [
        {
          "aggregator": "",
          "display_title": "",
          "event_id": 0,
          "event_type": "",
          "field": "",
          "role": "",
          "scope": ""
        }
      ],
      "project_id": 0,
      "scope": "",
      "visibility": "",
      "winning_direction": ""
    }
  ],
  "name": "Paid Users",
  "outcome": "",
  "percentage_included": 0,
  "status": "",
  "test_plan_name": "",
  "test_plan_type": "",
  "test_plan_url": "",
  "type": "",
  "updated_time": "2019-05-08T00:00:00.000Z",
  "urn": "rules.flags.optimizely.com::45633910",
  "variations": ""
}

400

// Malformed requests and invalid parameter names and types

401

// Invalid credentials

403

// Do not have permission to perform the operation

404

// Not found. No content