List Variations

1 min

GET

https://api.optimizely.com/flags/v1//projects/{project_id}/flags/{flag_key}/variations

Get a list of Variations for a specific Flag in a Project

You can use query parameters to filter/sort the response.

Path Parameters

project_idintegerrequired
Example
12345
Description
The project identifier
flag_keystringrequired
Example
recurring_deposit
Description
The Flag identifier

Query Parameters

per_pageinteger<int64>
Description
The max number of items to include per page or results.
Format
int64
page_tokenstring
Description
Pagination page token. Implements prev, next, last, first
page_windowinteger
Description
Number of previous and next page links to supply for the request (defaults to 1).
sortstring[]
Description
Sort the Variations based on the attributes from left to right.
archivedboolean
Description
Filter the Variations for a Flag by archived field status. A Variation for a Flag can be either archived (archived=true) or unarchived (archived=false)
enabledboolean
Description
Filter the Variations for a Flag by enabled field status. A Variation for a Flag can be either enabled (enabled=true) or disabled (enabled=false)
in_useboolean
Description
Filter the Variations for a Flag by whether the variation is used (in_use=true) or not (in_use=false) in rules.
querystring
Description
Filter the Variations for a Flag by name, key, or description substring

Responses

200

Successful retrieval of a page of Variations for a Flag.

The response includes RESTful JSON (https://restfuljson.org/) styled links and pagination metadata. Objects in this API MAY include a url property for a link to itself and MAY append _url to properties for related links. If a link is not present in the response, it indicates a user is not authorized to access the related resource.

Variations
- countintegerrequired
  Example
  1
  Description
  Number of Variations on the current page.
- create_urlobject
  Description
  Url template to create Variation for a Flag
  - UrlValue
- fetch_variation_urlobject
  Description
  A url template to be used to find a particular Variation.
  - UrlValue
- filter_urlobject
  Description
  Link to the default page of Variations with filter '.../{?filter}'
  - UrlValue
- first_urlobjectrequired
  Description
  Link to first page of Variations in a series.
  - UrlValue
- itemsVariation[]required
  - archive_urlobject
    Description
    Link to archive this Variation
    - UrlValue
  - archivedboolean
    Description
    Indicates if the Variation is archived or not
  - created_timestring<date-time>required
    Description
    Timestamp when the Variation is created
    Format
    date-time
  - delete_urlobject
    Description
    Link to delete this Variation
    - UrlValue
  - descriptionstring
    Description
    Additional context of the Variation
  - enabledboolean
    Description
    Indicates if the Variation is enabled or not
  - environment_usage_countmap<string, integer>
    Example
    { "development": 15, "production": 20 }
    Description
    Map of rule/ruleset count associated with the variation in each environment that includes environment key as key and count as value
  - fetch_flag_urlobject
    Description
    Link to flag url of this variation
    - UrlValue
  - flag_keystringrequired
    Description
    The Key of the Flag this Variation belongs to
  - idintegerrequired
    Description
    System generated Unique ID of the Variation
  - in_useboolean
    Description
    Indicates if the Variation is in use by a rule or a ruleset
  - keystringrequired
    Description
    User-facing Unique identifier of the Variation
  - namestringrequired
    Description
    User-facing name of the Variation
  - revisioninteger
    Description
    Revision number for tracking changes
  - rolestring
    Example
    admin
    Description
    Granular permission role
  - screenshot_namestring
    Example
    hero-banner.png
    Description
    Original filename of the uploaded screenshot image. Null when no screenshot has been attached.
    Max Length
    255
  - screenshot_urlstring
    Example
    /projects/123/files/a1b2c3d4-e5f6-7890-abcd-ef1234567890
    Description
    Backend proxy path to the variation's uploaded screenshot image. Null when no screenshot has been attached. Format: /projects/{project_id}/files/{file_id}
    Max Length
    2000
  - unarchive_urlobject
    Description
    Link to unarchive this Variation
    - UrlValue
  - update_urlobject
    Description
    Link to update this Variation
    - UrlValue
  - updated_timestring<date-time>required
    Description
    Timestamp when the Variation is updated
    Format
    date-time
  - urlobjectrequired
    Description
    Link to self
    - UrlValue
  - urnstringrequired
    Description
    The URN for the Variation
  - variablesmap<string, VariableValue>
    Description
    Map of flag variables that include variable key and value
- last_urlobjectrequired
  Description
  Link to the last page of Variations in a series.
  - UrlValue
- next_urlobject
  Description
  List of links to next pages of Variations in a series.
  
  The first element in the array is the exact next page after the current record, etc.
  - UrlList
- pageintegerrequired
  Example
  1
  Description
  Number of the current page. 1-index based.
- prev_urlobject
  Description
  List of links to previous pages of Variations in a series.
  
  The first element in the array is the exact previous page before the current record, etc.
  - UrlList
- reset_urlobject
  Description
  Link to the default page of Variations
  - UrlValue
- sort_urlobject
  Description
  Link to the default page of Variations with sort '.../{?sort}'
  - UrlValue
- total_countintegerrequired
  Example
  1
  Description
  Total number of Variations for this series.
- total_pagesintegerrequired
  Example
  1
  Description
  Total number of pages for this series.
- urlobjectrequired
  Description
  Link to self
  - UrlValue

400Malformed requests and invalid parameter names and types

401Invalid credentials

403Do not have permission to perform the operation

curl

curl --request GET \
     --url https://api.optimizely.com/flags/v1//projects/{project_id}/flags/{flag_key}/variations \
     --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}/variations", 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}/variations")

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}/variations"

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 page of Variations for a Flag.
The response includes RESTful JSON (https://restfuljson.org/) styled links and pagination metadata.
Objects in this API MAY include a url property for a link to itself and MAY append _url to properties for related links.
If a link is not present in the response, it indicates a user is not authorized to access the related resource.
{
  "count": 1,
  "create_url": {},
  "fetch_variation_url": {},
  "filter_url": {},
  "first_url": {},
  "items": [
    {
      "archive_url": {},
      "archived": false,
      "created_time": "",
      "delete_url": {},
      "description": "",
      "enabled": false,
      "environment_usage_count": "{\"development\":15,\"production\":20}",
      "fetch_flag_url": {},
      "flag_key": "",
      "id": 0,
      "in_use": false,
      "key": "",
      "name": "",
      "revision": 0,
      "role": "admin",
      "screenshot_name": "hero-banner.png",
      "screenshot_url": "/projects/123/files/a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "unarchive_url": {},
      "update_url": {},
      "updated_time": "",
      "url": {},
      "urn": "",
      "variables": ""
    }
  ],
  "last_url": {},
  "next_url": {},
  "page": 1,
  "prev_url": {},
  "reset_url": {},
  "sort_url": {},
  "total_count": 1,
  "total_pages": 1,
  "url": {}
}

400

// Malformed requests and invalid parameter names and types

401

// Invalid credentials

403

// Do not have permission to perform the operation