Fetch a Single Variation

1 min

GET

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

Fetch a single Variation for a Flag by its key.

This operation corresponds to the fetch_variation_url in a Variations response.

Path Parameters

project_idintegerrequired
Example
12345
Description
The project identifier
flag_keystringrequired
Example
recurring_deposit
Description
The Flag identifier
variation_keystringrequired
Example
high_discount
Description
The Variation identifier

Responses

200

Successful retrieval, creation or update of a Variation for a Flag.

The response includes RESTful JSON (https://restfuljson.org/) styled links. If a link is not present in the response, it indicates a user is not authorized to access the related resource.

Variation
Example
```
{
  "archive_url": "...",
  "archived": false,
  "created_time": "2019-05-08T00:00:00.000Z",
  "delete_url": "...",
  "description": "Use this to provide high discounts",
  "enabled": true,
  "environment_usage_count": {
    "development": 2,
    "production": 3
  },
  "fetch_flag_url": "...",
  "flag_key": "recurring_deposit",
  "id": 45633995,
  "key": "high_discount",
  "name": "High Discount",
  "revision": 1,
  "unarchive_url": "...",
  "update_url": "...",
  "updated_time": "2019-05-08T00:00:00.000Z",
  "url": "...",
  "urn": "variations.flag.optimizely.com::45633995",
  "variables": {
    "advanced": {
      "key": "advanced",
      "type": "json",
      "value": "{\n\t\"hello\": 123\n}"
    },
    "amount": {
      "key": "amount",
      "type": "double",
      "value": "10.0"
    },
    "message": {
      "key": "message",
      "type": "string",
      "value": "Enjoy!!"
    }
  }
}
```
- 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

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}/variations/{variation_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}/variations/{variation_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}/variations/{variation_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}/variations/{variation_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, creation or update of a Variation for a Flag.
The response includes RESTful JSON (https://restfuljson.org/) styled links. If a
link is not present in the response, it indicates a user is not authorized to access
the related resource.
{
  "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": ""
}

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