Log Endpoint

1 min

POST

https://logx.optimizely.com/v1/events

Body Parameters

bodyEventBatchrequired
Description
JSON object that holds an array of visitor objects that describe the visitor's experience during an Optimizely campaign.
- account_idstringrequired
  Example
  1234
  Description
  The Optimizely account to which these events should be attributed
- anonymize_ipboolean
  Description
  Optimizely typically stores the client IP address for each request. If this flag is true, the last octet of the IP will be truncated before it is stored. If false, the entire IP address will be stored. This is most relevant for consumers of this API that are implemented in a web browser or mobile client context who are subject to policies or regulation restricting the storage of end-user identifying information. Note that this flag is independent of the IP anonymization setting in the Account and Project settings, which only controls how Optimizely clients set this flag. Also note that if this flag is set, care must be taken when using the IP filtering feature, as fully-qualified explicit IP addresses will not function as filters (anonymization occurs before events are filtered by IP).
  Default
  true
- client_namestring
  Example
  acmecorp/offlineconversiontracker
  Description
  A unique identifier for the system that generated this event. By convention, this should be something like "organization_name/system_name".
- client_versionstring
  Example
  1.0.0
  Description
  A version identifier for the system that generated this event.
- enrich_decisionsboolean
  Description
  If true, additional processing is performed on each event in the EventBatch that simplifies the data requirements to track conversion events. Optimizely records the complete history of decisions that have been sent for each visitor which are represented as events of type campaign_activated. When enrich_decisions is enabled on an EventBatch, each of its events will have the recorded decisions automatically linked based on the event’s visitor_id and timestamp. In turn, the decisions required in an EventBatch are only those associated to a campaign_activated event in the same EventBatch. Additionally, due to the stateful nature of enrich_decisions, a campaign_activated event only needs to be sent once per visitor_id and entity_id, as long as the associated decision has not changed.
  Default
  false
- project_idstring
  Example
  5678
  Description
  The project_id needs only to be passed if you are using the Recommendations product.
- visitorsVisitor[]required
  Description
  An array of visitor objects that describe the visitor's experience during an Optimizely campaign.
  - attributesAttribute[]
    Description
    Attributes associated with this visitor at the time of this request
    - entity_idstring
      Example
      1234
      Description
      The ID of the entity corresponding to this Attribute. This is only required for custom attributes (type="custom"), and invalid for other Attribute types.
    - keystring
      Example
      shoe_purchased
      Description
      The key (or API name) of the this Attribute. This is only required for custom attributes (type="custom"), and optional for other Attribute types.
    - typestringrequired
      Example
      custom
      Description
      Describes what kind of Attribute this is (i.e., "custom", "location", etc.)
    - valuerequired
      Example
      nike zoom air
      Description
      The value can be an arbitrary string, integer, number, or a boolean. A boolean, integer or number can also be sent as a string value prefixed by the unicode character U+E000 . For example the integer 123 can be sent as "\UE000123".
  - session_idstring
    Example
    session_1231982382
    Description
    A unique identifier that identifies the session context, if any, for these events. If omitted, the Optimizely backend will calculate session-based results by inferring sessions by opening a session when an event is first received from a given visitor_id, and closing the session after 30 minutes with no events received for that visitor, with a maximum session size of 24 hours.
  - snapshotsSnapshot[]required
    Description
    An array of events triggered for an experiment, and the decision snapshot when that event occurred. Events can occur within different decision snapshots. Events occurring in different snapshots should be contained in different snapshot items.
    - decisionsDecision[]
      Description
      The list of bucketing Decisions made for the visitor (i.e. which experiments and variations the visitor was exposed to) for the duration of the session thus far. If the enrich_decisions option is enabled, just the Decisions associated to campaign_activated event in same Snapshot are necessary.
      - campaign_idstringrequired
        Example
        4321
        Description
        The id of the campaign containing this experiment.
      - experiment_idstringrequired
        Example
        1234
        Description
        The id of the experiment the visitor was exposed to. For Personalization Campaigns, clients should explicitly send null as the experiment_id for visitors not bucketed into any Experiment, for the purpose of accurately computing Campaign reach.
      - is_campaign_holdbackboolean
        Description
        If true, the chosen experience was held back at the campaign level. Required for Personalization, omit otherwise.
      - variation_idstringrequired
        Example
        5678
        Description
        The id of the variation the visitor was exposed to. For Personalization Campaigns, clients should explicitly send null as the variation_id for visitors not bucketed into any Experiment, for the purpose of accurately computing Campaign reach.
    - eventsEvent[]required
      Description
      The list of Events that should be recorded by the Optimizely backend within the given visitor, session and account context.
      - entity_idstring
        Example
        1234
        Description
        The id of the entity corresponding to this event.
      - keystring
        Example
        my_event_name
        Description
        The event key (aka API name) for this event.
      - quantityinteger
        Example
        4
        Description
        An aggregatable "count" associated with this event; for example, a number of video views or items in a shopping cart.
      - revenueinteger<int64>
        Example
        2342
        Description
        An aggregatable revenue amount associated with this event, in 1/100th of an arbitrary currency unit. For example, to represent $23.42, this field would be set to 2342.
        Format
        int64
      - tagsTags
        Example
        { "duration": 22, "video_title": "Funny Cats" }
        Description
        Arbitrary key value pairs attached to an event. The value can be a string, integer, number, or booean. A non-string type can also be sent as a string value prefixed by the unicode character U+E000. For example the integer 123 can be sent as "\UE000123".
      - timestampintegerrequired
        Example
        1485989442742316000
        Description
        Timestamp at which the event was generated, time since the epoch in milliseconds.
      - typestring
        Example
        campaign_activated
        Description
        the type of event. For example, to indicate a 'decision_point' type should be 'campaign_activated'.
      - uuidstringrequired
        Example
        0255F96D-922B-433B-B474-5D87EC1AB122
        Description
        A unique identifier for this Event. This may be generated by the client with a typical UUID-generating method. Used by Optimizely's backend to de-duplicate requests that are accidentally or erroneously replayed.
      - valuenumber
        Example
        1.234
        Description
        A scalar value associated with an event. This should be some non-revenue number.
  - visitor_idstringrequired
    Example
    user_32912378471284
    Description
    A unique identifier for the visitor

Responses

204The events were queued for recording by the Optimizely backend.

400The request is malformed or otherwise failed validation by the Optimizely backend.

500A server error occurred. The client should attempt to resend the events at a later time.

curl

curl --request POST \
     --url https://logx.optimizely.com/v1/events \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "account_id": "1234",
     "anonymize_ip": true,
     "visitors": [
     {
     "attributes": [
     {
     "type": "custom",
     "value": "nike zoom air"
     }
     ],
     "snapshots": [
     {
     "decisions": [
     {
     "campaign_id": "4321",
     "experiment_id": "1234",
     "variation_id": "5678"
     }
     ],
     "events": [
     {
     "timestamp": 1485989442742316000,
     "uuid": "0255F96D-922B-433B-B474-5D87EC1AB122"
     }
     ]
     }
     ],
     "visitor_id": "user_32912378471284"
     }
     ]
     }'

javascript

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

var raw = JSON.stringify({
   "account_id": "1234",
   "anonymize_ip": true,
   "visitors": [
      {
         "attributes": [
            {
               "type": "custom",
               "value": "nike zoom air"
            }
         ],
         "snapshots": [
            {
               "decisions": [
                  {
                     "campaign_id": "4321",
                     "experiment_id": "1234",
                     "variation_id": "5678"
                  }
               ],
               "events": [
                  {
                     "timestamp": 1485989442742316000,
                     "uuid": "0255F96D-922B-433B-B474-5D87EC1AB122"
                  }
               ]
            }
         ],
         "visitor_id": "user_32912378471284"
      }
   ]
});

var requestOptions = {
   method: 'POST',
   headers: myHeaders,
   body: raw,
   redirect: 'follow'
};

fetch("https://logx.optimizely.com/v1/events", 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://logx.optimizely.com/v1/events")

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

request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request.body = JSON.dump({
   "account_id": "1234",
   "anonymize_ip": true,
   "visitors": [
      {
         "attributes": [
            {
               "type": "custom",
               "value": "nike zoom air"
            }
         ],
         "snapshots": [
            {
               "decisions": [
                  {
                     "campaign_id": "4321",
                     "experiment_id": "1234",
                     "variation_id": "5678"
                  }
               ],
               "events": [
                  {
                     "timestamp": 1485989442742316000,
                     "uuid": "0255F96D-922B-433B-B474-5D87EC1AB122"
                  }
               ]
            }
         ],
         "visitor_id": "user_32912378471284"
      }
   ]
})

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

python

import requests
import json

url = "https://logx.optimizely.com/v1/events"

payload = json.dumps({
   "account_id": "1234",
   "anonymize_ip": True,
   "visitors": [
      {
         "attributes": [
            {
               "type": "custom",
               "value": "nike zoom air"
            }
         ],
         "snapshots": [
            {
               "decisions": [
                  {
                     "campaign_id": "4321",
                     "experiment_id": "1234",
                     "variation_id": "5678"
                  }
               ],
               "events": [
                  {
                     "timestamp": 1485989442742316000,
                     "uuid": "0255F96D-922B-433B-B474-5D87EC1AB122"
                  }
               ]
            }
         ],
         "visitor_id": "user_32912378471284"
      }
   ]
})
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

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

print(response.text)

204

// The events were queued for recording by the Optimizely backend.

400

// The request is malformed or otherwise failed validation by the Optimizely backend.

500

// A server error occurred. The client should attempt to resend the events at a later time.