Get a microsnippet response

1 min

GET

https://optimizely-edge.com/edge-client/v1/{accountId}/{projectId}

Call the Edge Decider API to fetch a microsnippet. Given the required arguments, the Edge Decider will bucket visitors into variations of active experiments they're qualified for and return the JavaScript microsnippet. The microsnippet is executed by the browser to apply the variations' changes.

Note that for security, the Edge Decider API only supports connections made over HTTPS. It does not support connections made over insecure HTTP and responds with a 403 status instead.

Path Parameters

accountIdstringrequired
Description
Optimizely Account ID
projectIdstringrequired
Description
Project ID of the Performance Edge project.

Query Parameters

extend_cookie_lifetimestring
Description
Whether or not the snippet should extend cookies. Defaults to true.

Only has an effect on cookies which are already set, according to the Cookie header value. If it has not been set before, the cookie is set regardless of this parameter value.

Currently, this only affects the "OptimizelyEndUserId" cookie.
Allowed
false
urlstring
Description
Document URL requested, which is used to determine the active pages(s)/experiment(s)

Needs to be passed encoded.

Header Parameters

Cookiestringrequired
Description
Cookies set on the requested domain. For cookie targeting, userId derivation, bucketing. Include any cookies that your users may want to use to define visitor audiences.

At a minimum, must include the value of the optimizelyEndUserId cookie, if set. If unset, the JavaScript response will instruct the browser to set that cookie on the user’s device.

NOTE Please review our guidance on usage of PII with Optimizely Products.
Refererstringrequired
Description
Document URL requested, which is used to determine the active pages(s)/experiment(s), if the “url” query parameter is not specified.

In typical implementations, the Referer header in the script request will equal the URL of the page on which the script was loaded.
User-Agentstringrequired
Description
User Agent used to make the request. Optimizely Edge will only serve the JavaScript response to browsers that are detected as having support for it, using this value. Also used for browser, device, platform targeting (Reference)
X-Forwarded-Forstringrequired
Description
A comma-separated list of IP addresses, the first of which will be used as the basis for IP Address and Location experiment targeting. (Reference)

Responses

200Successful response supplies JavaScript code for microsnippet

403Request made not using HTTPS

405Invalid input

curl

curl --request GET \
     --url https://optimizely-edge.com/edge-client/v1/{accountId}/{projectId} \
     --header 'accept: application/json' \
     --cookie string \
     --header 'referer: string' \
     --header 'user-agent: string' \
     --header 'x-forwarded-for: string'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
myHeaders.append("cookie", "string");
myHeaders.append("referer", "string");
myHeaders.append("user-agent", "string");
myHeaders.append("x-forwarded-for", "string");

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

fetch("https://optimizely-edge.com/edge-client/v1/{accountId}/{projectId}", 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://optimizely-edge.com/edge-client/v1/{accountId}/{projectId}")

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"
request["cookie"] = "string"
request["referer"] = "string"
request["user-agent"] = "string"
request["x-forwarded-for"] = "string"

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

python

import requests
import json

url = "https://optimizely-edge.com/edge-client/v1/{accountId}/{projectId}"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json',
   'cookie': 'string',
   'referer': 'string',
   'user-agent': 'string',
   'x-forwarded-for': 'string'
}

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

print(response.text)

200

// Successful response supplies JavaScript code for microsnippet

403

// Request made not using HTTPS

405

// Invalid input