Get Experiment results time series

1 min

GET

https://api.optimizely.com/v2/experiments/{experiment_id}/timeseries

Get results time series for a single Experiment

Path Parameters

experiment_idinteger<int64>required
Description
The ID for the Experiment you want results for
Format
int64

Query Parameters

baseline_variation_idstring<int64>
Description
The ID of the variation to use as the baseline to compare against other variations. Defaults to the first variation if not provided. For an experience in a personalization campaign, the value can also be the string 'holdback'.
Format
int64
start_timestring<date-time>
Description
The start time of the time interval (beginning time included) used to calculate the results over. If unspecified, defaults to the time that the Experiment was first activated. The start time will be rounded the smallest time modulo 5 minutes larger or equal to start_time.
Format
date-time
end_timestring<date-time>
Description
The end of the time interval (end time excluded) used to calculate results over. If unspecified, defaults to the current time if the Experiment is still running, otherwise defaults to the time the experiment was last active. The end time will be rounded to the largest time modulo 5 minutes smaller or equal to end_time. The end_time in the response may be earlier than requested if fresher results are not available yet. In this case, the results will continue to calculate in the background and subsequent requests will eventually return the full results.
Format
date-time
browserstring
Description
Browser to segment results by. This parameter must not be sent with any other segmentation parameters, i.e. any parameters in [device, source, attribute_id, attribute_value].
Allowed
firefoxchromeinternet_exploreroperasafari
devicestring
Description
Device to segment results by. This parameter must not be sent with any other segmentation parameters, i.e. any parameters in [browser, source, attribute_id, attribute_value].
Allowed
desktopipadiphonemobiletablet
sourcestring
Description
Source to segment results by. This parameter must not be sent with any other segmentation parameters, i.e. any parameters in [browser, device, attribute_id, attribute_value]. Campaign: Contains users that arrive on a URL containing a 'utm_campaign,' 'utm_source,' 'gclid,' or 'otm_source' query parameter. If the URL contains one of these parameters, the visitor will count as "Campaign" traffic even if they arrived through search. Direct: Includes all users who do not have any external referrer in their URL. Referral: Includes all users that come from another URL that doesn't count as Campaign.
Allowed
campaigndirectreferralsearch
attribute_idinteger<int64>
Description
ID of the attribute to segment results by. Requests containing attribute_id will return the results for all visitors that have attribute_value for the attribute represented by attribute_id. If present, the attribute_value parameter must also be present, and it cannot be sent with any other segmentation parameters, i.e. any parameters in [browser, device, source].
Format
int64
attribute_valuestring
Description
UTF-8 encoded value correlating to attribute_id. If present, the attribute_id parameter must also be present. This parameter also requires attribute_id to be set, and cannot be sent with any other segmentation parameters, i.e. any parameters in [browser, device, source].
segment_conditionsstring
Description
(BETA) A string representation of a JSON Segment Conditions Expression. This parameter can be either URL-escaped stringified JSON or Base64-encoded stringified JSON using URL-safe alphabet (preferred). Segment Conditions Expressions consist of Logical Expressions and Match Expressions. Logical Expressions are represented as an array of the format [, ...], where the supported operators are "and", "or" and "not". Match Expressions are represented as an object of the format {"attribute_id": <attribute_id>, "attribute_value": [, "match_type": <match_type>]}, where supported values for match_type are "exact" match type will match only an exact string match between "value" string and the attribute value. "substring" match type will match if "value" is a substring of the attribute value. "prefix" match type will match if "value" is a string prefix of the attribute value. "regex" match type will match if "value" is a regular expression match for the attribute value. The default match_type is "exact".

Responses

200Return Experiment results time series

ExperimentTimeseries
- confidence_thresholdnumber<double>
  Example
  0.9
  Description
  The significance level at which you would like to declare winning and losing variations. A lower number minimizes the time needed to declare a winning or losing variation, but increases the risk that your results aren't true winners and losers.
  Format
  double
- end_timestring<date-time>
  Description
  End of the time interval (exclusive) used to calculated the results. The time is formatted in ISO 8601.
  Format
  date-time
- experiment_idinteger<int64>
  Example
  3000
  Description
  The unique identifier for the Experiment
  Format
  int64
- is_staleboolean
  Description
  When true, indicates the results were delivered from a cache that is out of date.
- metricsExperimentMetricTimeseries[]
  Description
  The breakdown of Experiment results time series by metric
  - aggregatorstring<unique | count | sum | bounce | exit | ratio>
    Description
    The aggregation function for the numerator of the metric. 'unique' measures the number of unique visitors/sessions that include the specified Event. 'count' measures the total number of occurrences of Event for the scope (visitor/session). 'sum' is the sum of the 'field' value
    Allowed
    uniquecountsumbounceexitratio
  - event_idinteger<int64>
    Description
    The ID for the Event to select data from. Omitted for global metrics that are not relative to a specific Event, i.e. "overall revenue"
    Format
    int64
  - event_propertiesMetricEventProperties
    Description
    The conditions used to filter the metric on specific event property values.
    - filterMetricFilter
      Description
      The set of event property conditions a conversion must match to be counted toward the metric.
      - combine_operatorstring<and | or>
        Description
        Determines whether all conditions (and) or any condition (or) must be met.
        Allowed
        andor
      - conditionsMetricFilterCondition[]
        Description
        defines the event property values and operator used to check whether the conversion meets the condition.
        namestring
        Description
        The name of the event property to match to.
        operatorstring<equal_to | not_equal_to | greater_than | greater_than_or_equal_to | less_than | less_than_or_equal_to | contains | does_not_contain>
        Description
        The type of match to be performed. equal_to and not_equal_to are available for all property types. greater_than, greater_than_or_equal_to, less_than, and less_than_or_equal_to are only available for properties with type number. contains and does_not_contain are only available for properties with type string.
        Allowed
        equal_tonot_equal_togreater_thangreater_than_or_equal_toless_thanless_than_or_equal_tocontainsdoes_not_contain
        typestring<boolean | number | string>
        Description
        The data type of the event property.
        Allowed
        booleannumberstring
        valuestring
        Description
        The value the conversion's property should match, according to the operator.
  - fieldstring<revenue | value>
    Description
    The field to aggregate for the numerator of the metric. Required when 'aggregator' = 'sum', otherwise omitted
    Allowed
    revenuevalue
  - metricsCompoundSubMetric[]
    Description
    A list of all metrics that will be used in the calculation of a ratio metric.
    - aggregatorstring<unique | count | sum>
      Description
      The aggregation function for the numerator of the metric. 'unique' measures the number of unique visitors/sessions that include the specified Event. 'count' measures the total number of occurrences of Event for the scope (visitor/session). 'sum' is the sum of the 'field' value.
      Default
      unique
      Allowed
      uniquecountsum
    - event_idinteger<int64>
      Description
      The ID for the Event to select data from.
      Format
      int64
    - event_typestring<custom | click | pageview>
      Description
      The type of this Event.
      Allowed
      customclickpageview
    - fieldstring<revenue | value>
      Description
      The field to aggregate for the numerator of the metric. Required when 'aggregator' = 'sum', otherwise omitted.
      Allowed
      revenuevalue
    - scopestring<session | visitor | event>
      Description
      Specifies how Events should be grouped. Can also be thought of as the denominator of the metric. 'session' divides by the number of sessions. "Influenced sessions", or sessions that do not contain a decision Event but carry a decision from a previous session are not included in counts for numerator or denominator. 'visitor' divides by the number of visitors. 'event' divides by the total occurrences (impressions) of the specified Event.
      Default
      visitor
      Allowed
      sessionvisitorevent
  - namestring
    Description
    The name of the Metric
  - resultsmap<string, VariantTimeseries>
    Description
    A map of results for each variation in the Experiment keyed by variation ID. For Personalization Campaigns, the special variant 'baseline' represents visitors that have been held back from any change in experience for the Experiment
  - scopestring<session | visitor | event>
    Description
    Specifies how Events should be grouped together. Can also be thought of as the denonimator of the metric. 'session' divides by the number of sessions. "Influenced sessions", or sessions that do not contain a decision Event but carry a decision from a previous session are not included in counts for numerator or denominator. 'visitor' divides by the number of visitors. 'event' divides by the total occurrences (impressions) of the specified Event
    Allowed
    sessionvisitorevent
  - time_windowstring
    Description
    The maximum amount of time a numerator event can differ from a denominator event in order to be included in a ratio metric. This can be an integer, or an integer followed by a letter denoting the unit of time (d = days, h = hours, m = minutes). If no unit of time is supplied, hours is assumed. If no value is supplied, a time window of 48 hours is assumed.
  - winning_directionstring<increasing | decreasing>
    Description
    The winning direction of this metric
    Allowed
    increasingdecreasing
- start_timestring<date-time>
  Description
  Start of the time interval (inclusive) used to calculate the results. The time is formatted in ISO 8601.
  Format
  date-time
- stats_configStatsConfig
  Description
  Stats Engine configuration settings
  - confidence_levelnumber
  - difference_typestring<absolute | relative>
    Description
    The type of test to compare the variant to baseline
    Allowed
    absoluterelative
  - epoch_enabledboolean
    Description
    Indicates if epoch-based statistics were used

202The results request has been received but has not yet finished processing. Wait a bit and try again.

204There are no results data for this Experiment yet. Make sure the Experiment is started and try again later

defaultUnexpected error

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

curl

curl --request GET \
     --url https://api.optimizely.com/v2/experiments/{experiment_id}/timeseries \
     --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/experiments/{experiment_id}/timeseries", 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/experiments/{experiment_id}/timeseries")

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/experiments/{experiment_id}/timeseries"

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

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

print(response.text)

200

// Return Experiment results time series
{
  "confidence_threshold": 0.9,
  "end_time": "",
  "experiment_id": 3000,
  "is_stale": false,
  "metrics": [
    {
      "aggregator": "",
      "event_id": "",
      "event_properties": {
        "filter": {
          "combine_operator": "",
          "conditions": [
            {
              "name": "",
              "operator": "",
              "type": "",
              "value": ""
            }
          ]
        }
      },
      "field": "",
      "metrics": [
        {
          "aggregator": "",
          "event_id": "",
          "event_type": "",
          "field": "",
          "scope": ""
        }
      ],
      "name": "",
      "results": "",
      "scope": "",
      "time_window": "",
      "winning_direction": ""
    }
  ],
  "start_time": "",
  "stats_config": {
    "confidence_level": 0,
    "difference_type": "",
    "epoch_enabled": false
  }
}

202

// The results request has been received but has not yet finished processing. Wait a bit and try again.

204

// There are no results data for this Experiment yet. Make sure the Experiment is started and try again later

default

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