Experiments

The experiments collection is a set of experiment resources, each of which describes a content experiment available to an authenticated user.

For a list of methods for this resource, see the end of this page.

Resource representations

JSON template for Analytics experiment resource.

{
  "id": string,
  "kind": "analytics#experiment",
  "selfLink": string,
  "accountId": string,
  "webPropertyId": string,
  "internalWebPropertyId": string,
  "profileId": string,
  "name": string,
  "description": string,
  "created": datetime,
  "updated": datetime,
  "objectiveMetric": string,
  "optimizationType": string,
  "status": string,
  "winnerFound": boolean,
  "startTime": datetime,
  "endTime": datetime,
  "reasonExperimentEnded": string,
  "rewriteVariationUrlsAsOriginal": boolean,
  "winnerConfidenceLevel": double,
  "minimumExperimentLengthInDays": integer,
  "trafficCoverage": double,
  "equalWeighting": boolean,
  "snippet": string,
  "variations": [
    {
      "name": string,
      "url": string,
      "status": string,
      "weight": double,
      "won": boolean
    }
  ],
  "servingFramework": string,
  "editableInGaUi": boolean,
  "parentLink": {
    "type": "analytics#profile",
    "href": string
  }
}
Property name Value Description Notes
accountId string Account ID to which this experiment belongs. This field is read-only.
created datetime Time the experiment was created. This field is read-only.
description string Notes about this experiment. writable
editableInGaUi boolean If true, the end user will be able to edit the experiment via the Google Analytics user interface. writable
endTime datetime 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. writable
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 experiment whose status is ENDED. writable
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. writable
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". writable
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". writable
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 experiment whose status is ENDED. writable
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.
writable
snippet string The snippet of code to include on the control page(s). This field is read-only.
startTime datetime 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. writable
trafficCoverage double A floating-point number between 0 and 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 experiment whose status is ENDED. writable
updated datetime Time the experiment was last modified. This field is read-only.
variations[] list Array of variations. The first variation in the array is the original. The number of variations may not change once an experiment is in the RUNNING state. At least two variations are required before status can be set to RUNNING. writable
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. writable
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. writable
variations[].url string The URL of the variation. This field may not be changed for an experiment whose status is RUNNING or ENDED. writable
variations[].weight double 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 double A floating-point number between 0 and 1. Specifies the necessary confidence level to choose a winner. This field may not be changed for an experiment whose status is ENDED. writable
winnerFound boolean Boolean specifying whether a winner has been found for this experiment. This field is read-only.

Methods

delete
Delete an experiment.
get
Returns an experiment to which the user has access.
insert
Create a new experiment.
list
Lists experiments to which the user has access.
patch
Update an existing experiment. This method supports patch semantics.
update
Update an existing experiment.