accountId STRING Required

Account ID to create the experiment for

webPropertyId STRING Required

Web property ID to create the experiment for

profileId STRING Required

View (Profile) ID to create the experiment for

accountId STRING

Account ID to which this experiment belongs. This field is read-only

created DATE_TIME

Time the experiment was created. This field is read-only

description STRING

Notes about this experiment

editableInGaUi BOOLEAN

If true, the end user will be able to edit the experiment via the Google Analytics user interface

endTime DATE_TIME

The ending time of the experiment (the time the status changed from RUNNING to ENDED). This field is present only if the experiment has ended. This field is read-only

equalWeighting BOOLEAN

Boolean specifying whether to distribute traffic evenly across all variations. If the value is False, content experiments follows the default behavior of adjusting traffic dynamically based on variation performance. Optional -- defaults to False. This field may not be changed for an experiment whose status is ENDED

id STRING

Experiment ID. Required for patch and update. Disallowed for create

internalWebPropertyId STRING

Internal ID for the web property to which this experiment belongs. This field is read-only

kind STRING

Resource type for an Analytics experiment. This field is read-only

minimumExperimentLengthInDays INTEGER

An integer number in [3, 90]. Specifies the minimum length of the experiment. Can be changed for a running experiment. This field may not be changed for an experiments whose status is ENDED

name STRING

Experiment name. This field may not be changed for an experiment whose status is ENDED. This field is required when creating an experiment

objectiveMetric STRING

The metric that the experiment is optimizing. Valid values: "ga:goal(n)Completions", "ga:adsenseAdsClicks", "ga:adsenseAdsViewed", "ga:adsenseRevenue", "ga:bounces", "ga:pageviews", "ga:sessionDuration", "ga:transactions", "ga:transactionRevenue". This field is required if status is "RUNNING" and servingFramework is one of "REDIRECT" or "API"

optimizationType STRING

Whether the objectiveMetric should be minimized or maximized. Possible values: "MAXIMUM", "MINIMUM". Optional--defaults to "MAXIMUM". Cannot be specified without objectiveMetric. Cannot be modified when status is "RUNNING" or "ENDED"

parentLink OBJECT

Parent link for an experiment. Points to the view (profile) to which this experiment belongs

parentLink.href STRING

Link to the view (profile) to which this experiment belongs. This field is read-only

parentLink.type STRING

Value is "analytics#profile". This field is read-only

profileId STRING

View (Profile) ID to which this experiment belongs. This field is read-only

reasonExperimentEnded STRING

Why the experiment ended. Possible values: "STOPPED_BY_USER", "WINNER_FOUND", "EXPERIMENT_EXPIRED", "ENDED_WITH_NO_WINNER", "GOAL_OBJECTIVE_CHANGED". "ENDED_WITH_NO_WINNER" means that the experiment didn't expire but no winner was projected to be found. If the experiment status is changed via the API to ENDED this field is set to STOPPED_BY_USER. This field is read-only

rewriteVariationUrlsAsOriginal BOOLEAN

Boolean specifying whether variations URLS are rewritten to match those of the original. This field may not be changed for an experiments whose status is ENDED

selfLink STRING

Link for this experiment. This field is read-only

servingFramework STRING

The framework used to serve the experiment variations and evaluate the results. One of:

• REDIRECT: Google Analytics redirects traffic to different variation pages, reports the chosen variation and evaluates the results.
• API: Google Analytics chooses and reports the variation to serve and evaluates the results; the caller is responsible for serving the selected variation.
• EXTERNAL: The variations will be served externally and the chosen variation reported to Google Analytics. The caller is responsible for serving the selected variation and evaluating the results.

snippet STRING

The snippet of code to include on the control page(s). This field is read-only

startTime DATE_TIME

The starting time of the experiment (the time the status changed from READY_TO_RUN to RUNNING). This field is present only if the experiment has started. This field is read-only

status STRING

Experiment status. Possible values: "DRAFT", "READY_TO_RUN", "RUNNING", "ENDED". Experiments can be created in the "DRAFT", "READY_TO_RUN" or "RUNNING" state. This field is required when creating an experiment

trafficCoverage NUMBER

A floating-point number in (0, 1]. Specifies the fraction of the traffic that participates in the experiment. Can be changed for a running experiment. This field may not be changed for an experiments whose status is ENDED

updated DATE_TIME

Time the experiment was last modified. This field is read-only

variations[] OBJECT

variations[].name STRING

The name of the variation. This field is required when creating an experiment. This field may not be changed for an experiment whose status is ENDED

variations[].status STRING

Status of the variation. Possible values: "ACTIVE", "INACTIVE". INACTIVE variations are not served. This field may not be changed for an experiment whose status is ENDED

variations[].url STRING

The URL of the variation. This field may not be changed for an experiment whose status is RUNNING or ENDED

variations[].weight NUMBER

Weight that this variation should receive. Only present if the experiment is running. This field is read-only

variations[].won BOOLEAN

True if the experiment has ended and this variation performed (statistically) significantly better than the original. This field is read-only

webPropertyId STRING

Web property ID to which this experiment belongs. The web property ID is of the form UA-XXXXX-YY. This field is read-only

winnerConfidenceLevel NUMBER

A floating-point number in (0, 1). Specifies the necessary confidence level to choose a winner. This field may not be changed for an experiments whose status is ENDED

winnerFound BOOLEAN

Boolean specifying whether a winner has been found for this experiment. This field is read-only

accountId STRING

Account ID to which this experiment belongs. This field is read-only

created DATE_TIME

Time the experiment was created. This field is read-only

description STRING

Notes about this experiment

editableInGaUi BOOLEAN

If true, the end user will be able to edit the experiment via the Google Analytics user interface

endTime DATE_TIME

The ending time of the experiment (the time the status changed from RUNNING to ENDED). This field is present only if the experiment has ended. This field is read-only

equalWeighting BOOLEAN

Boolean specifying whether to distribute traffic evenly across all variations. If the value is False, content experiments follows the default behavior of adjusting traffic dynamically based on variation performance. Optional -- defaults to False. This field may not be changed for an experiment whose status is ENDED

id STRING

Experiment ID. Required for patch and update. Disallowed for create

internalWebPropertyId STRING

Internal ID for the web property to which this experiment belongs. This field is read-only

kind STRING

Resource type for an Analytics experiment. This field is read-only

minimumExperimentLengthInDays INTEGER

An integer number in [3, 90]. Specifies the minimum length of the experiment. Can be changed for a running experiment. This field may not be changed for an experiments whose status is ENDED

name STRING

Experiment name. This field may not be changed for an experiment whose status is ENDED. This field is required when creating an experiment

objectiveMetric STRING

The metric that the experiment is optimizing. Valid values: "ga:goal(n)Completions", "ga:adsenseAdsClicks", "ga:adsenseAdsViewed", "ga:adsenseRevenue", "ga:bounces", "ga:pageviews", "ga:sessionDuration", "ga:transactions", "ga:transactionRevenue". This field is required if status is "RUNNING" and servingFramework is one of "REDIRECT" or "API"

optimizationType STRING

Whether the objectiveMetric should be minimized or maximized. Possible values: "MAXIMUM", "MINIMUM". Optional--defaults to "MAXIMUM". Cannot be specified without objectiveMetric. Cannot be modified when status is "RUNNING" or "ENDED"

parentLink OBJECT

Parent link for an experiment. Points to the view (profile) to which this experiment belongs

parentLink.href STRING

Link to the view (profile) to which this experiment belongs. This field is read-only

parentLink.type STRING

Value is "analytics#profile". This field is read-only

profileId STRING

View (Profile) ID to which this experiment belongs. This field is read-only

reasonExperimentEnded STRING

Why the experiment ended. Possible values: "STOPPED_BY_USER", "WINNER_FOUND", "EXPERIMENT_EXPIRED", "ENDED_WITH_NO_WINNER", "GOAL_OBJECTIVE_CHANGED". "ENDED_WITH_NO_WINNER" means that the experiment didn't expire but no winner was projected to be found. If the experiment status is changed via the API to ENDED this field is set to STOPPED_BY_USER. This field is read-only

rewriteVariationUrlsAsOriginal BOOLEAN

Boolean specifying whether variations URLS are rewritten to match those of the original. This field may not be changed for an experiments whose status is ENDED

selfLink STRING

Link for this experiment. This field is read-only

servingFramework STRING

The framework used to serve the experiment variations and evaluate the results. One of:

• REDIRECT: Google Analytics redirects traffic to different variation pages, reports the chosen variation and evaluates the results.
• API: Google Analytics chooses and reports the variation to serve and evaluates the results; the caller is responsible for serving the selected variation.
• EXTERNAL: The variations will be served externally and the chosen variation reported to Google Analytics. The caller is responsible for serving the selected variation and evaluating the results.

snippet STRING

The snippet of code to include on the control page(s). This field is read-only

startTime DATE_TIME

The starting time of the experiment (the time the status changed from READY_TO_RUN to RUNNING). This field is present only if the experiment has started. This field is read-only

status STRING

Experiment status. Possible values: "DRAFT", "READY_TO_RUN", "RUNNING", "ENDED". Experiments can be created in the "DRAFT", "READY_TO_RUN" or "RUNNING" state. This field is required when creating an experiment

trafficCoverage NUMBER

A floating-point number in (0, 1]. Specifies the fraction of the traffic that participates in the experiment. Can be changed for a running experiment. This field may not be changed for an experiments whose status is ENDED

updated DATE_TIME

Time the experiment was last modified. This field is read-only

variations[] OBJECT

variations[].name STRING

The name of the variation. This field is required when creating an experiment. This field may not be changed for an experiment whose status is ENDED

variations[].status STRING

Status of the variation. Possible values: "ACTIVE", "INACTIVE". INACTIVE variations are not served. This field may not be changed for an experiment whose status is ENDED

variations[].url STRING

The URL of the variation. This field may not be changed for an experiment whose status is RUNNING or ENDED

variations[].weight NUMBER

Weight that this variation should receive. Only present if the experiment is running. This field is read-only

variations[].won BOOLEAN

True if the experiment has ended and this variation performed (statistically) significantly better than the original. This field is read-only

webPropertyId STRING

Web property ID to which this experiment belongs. The web property ID is of the form UA-XXXXX-YY. This field is read-only

winnerConfidenceLevel NUMBER

A floating-point number in (0, 1). Specifies the necessary confidence level to choose a winner. This field may not be changed for an experiments whose status is ENDED

winnerFound BOOLEAN

Boolean specifying whether a winner has been found for this experiment. This field is read-only