Get Experiment results time series

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

Get results time series for a single Experiment

Path Params

experiment_id

int64

required

The ID for the Experiment you want results for

Query Params

baseline_variation_id

string

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'.

start_time

date-time

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.

end_time

date-time

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.

browser

string

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].

device

string

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].

source

string

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.

attribute_id

int64

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].

attribute_value

string

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_conditions

string

(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

Response body

object

confidence_threshold

double

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.

end_time

date-time

End of the time interval (exclusive) used to calculated the results. The time is formatted in ISO 8601.

experiment_id

int64

The unique identifier for the Experiment

is_stale

boolean

When true, indicates the results were delivered from a cache that is out of date.

metrics

array of objects

The breakdown of Experiment results time series by metric

metrics

object

aggregator

string

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

unique count sum bounce exit ratio

event_id

int64 | null

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"

event_properties

object

The conditions used to filter the metric on specific event property values.

field

string

The field to aggregate for the numerator of the metric. Required when 'aggregator' = 'sum', otherwise omitted

revenue value

metrics

array of objects

A list of all metrics that will be used in the calculation of a ratio metric.

metrics

object

aggregator

string

Defaults to unique

unique count sum

event_id

int64 | null

The ID for the Event to select data from.

event_type

string

The type of this Event.

custom click pageview

field

string | null

The field to aggregate for the numerator of the metric. Required when 'aggregator' = 'sum', otherwise omitted.

revenue value

scope

string

Defaults to visitor

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.

session visitor event

name

string

The name of the Metric

results

object

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

scope

string

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

session visitor event

time_window

string

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_direction

string

The winning direction of this metric

increasing decreasing

start_time

date-time

Start of the time interval (inclusive) used to calculate the results. The time is formatted in ISO 8601.

stats_config

object

Stats Engine configuration settings

confidence_level

number

difference_type

string

The type of test to compare the variant to baseline

absolute relative

epoch_enabled

boolean

Indicates if epoch-based statistics were used

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

Language

Credentials


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.optimizely.com/v2/experiments/experiment_id/timeseries \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Optimizely developer documentation

How can we help you?

Optimizely developer documentation

How can we help you?

Get Experiment results time series

200Return Experiment results time series

defaultUnexpected error