Get bucketing information for a visitor

1 min

GET

https://api.optimizely.com/v2/attribution/{account_id}/visitor/{visitor_id}

Get a list of experiments within a project a visitor has been exposed to

Path Parameters

account_idinteger<int64>required
Description
The unique identifier of the Optimizely Account
Format
int64
visitor_idstringrequired
Description
The Optimizely User ID of the visitor

Query Parameters

start_timestring<date-time>
Description
Start of the time interval (inclusive) used to filter the bucketing decisions. The time is formatted in ISO 8601.
Format
date-time
end_timestring<date-time>
Description
End of the time interval (inclusive) used to filter the bucketing decisions. The time is formatted in ISO 8601.
Format
date-time

Responses

200Return bucketing information

BucketingInformation
- account_idinteger<int64>
  Example
  1000
  Description
  ID of the Account
  Format
  int64
- bucketing_historyBucketingInformationItem[]
  Description
  Array of bucketing information items
  - campaign_idinteger<int64>
    Example
    2056053765
    Description
    The unique identifier of the Campaign
    Format
    int64
  - experiment_idinteger<int64>
    Example
    9387397797
    Description
    The unique identifier of the Experiment
    Format
    int64
  - is_holdbackboolean
    Description
    Is the visitor bucketed into a variation or a holdback
  - timestampinteger<int64>
    Example
    1545871675000
    Description
    The timestamp of the bucketing decision on the client side
    Format
    int64
  - variation_idinteger<int64>
    Example
    5042153527
    Description
    The unique identifier of the Variation
    Format
    int64
- visitor_idstring<uuid>
  Example
  fa74a14b-1f3a-463d-aa98-2f7124ee6fc3
  Description
  The unique identifier of the visitor
  Format
  uuid

401Invalid credentials

Error
- codestring
- messagestring
- messagesobject
- uuidstring<uuid>
  Format
  uuid

403You do not have permission to access bucketing history information

Error
- codestring
- messagestring
- messagesobject
- uuidstring<uuid>
  Format
  uuid

defaultUnexpected error

Error
- codestring
- messagestring
- messagesobject
- uuidstring<uuid>
  Format
  uuid

curl

curl --request GET \
     --url https://api.optimizely.com/v2/attribution/{account_id}/visitor/{visitor_id} \
     --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/v2/attribution/{account_id}/visitor/{visitor_id}", 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/v2/attribution/{account_id}/visitor/{visitor_id}")

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/v2/attribution/{account_id}/visitor/{visitor_id}"

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

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

print(response.text)

200

// Return bucketing information
{
  "account_id": 1000,
  "bucketing_history": [
    {
      "campaign_id": 2056053765,
      "experiment_id": 9387397797,
      "is_holdback": false,
      "timestamp": 1545871675000,
      "variation_id": 5042153527
    }
  ],
  "visitor_id": "fa74a14b-1f3a-463d-aa98-2f7124ee6fc3"
}

401

// Invalid credentials
{
  "code": "",
  "message": "",
  "messages": {},
  "uuid": ""
}

403

// You do not have permission to access bucketing history information
{
  "code": "",
  "message": "",
  "messages": {},
  "uuid": ""
}

default

// Unexpected error
{
  "code": "",
  "message": "",
  "messages": {},
  "uuid": ""
}