The Website Optimizer Experiment Management API provides the following feed types:
This section contains reference information about these feeds, regardless of the client library you are using for your application. For all feeds, there are a number of considerations you should keep in mind:
|
0, for start-index will result in a 400
Bad Request response from the server.ID, title, and author.The experiments feed returns either:
{experimentId} is
set to the ID of an experiment)
When displaying a list of experiments, only general information about each experiment
is contained in the feed. Typically, an application will use websiteoptimizer/experiments in
the feed query to get the experiment ID for an experiment. If will then use websiteoptimizer/experiments/xxxxx (where
xxxxx is the experiment ID) to get more detailed experiment information.
id—a unique URI of the form http://www.google.com/analytics/feeds/websiteoptimizer/experiments.title—the string Experiment list for '{userName}'.totalResults—the total number of results for the
query, regardless of the number of results in the response.startIndex—the starting index of the entries, which
is 1 by default or otherwise specified by the start-index query parameter.itemsPerPage—The number of items in the current request, which has
a maximum of 100.id—A string that uniquely identifies this experiment entry. Example: http://www.google.com/analytics/feeds/websiteoptimizer/experiment/{experimentId}.title
—the title of the experiment.gwo:experimentId—the experiment ID for this experiment. (read-only)gwo:experimentType—the experiment type: AB or Multivariate.
(read-only; may be set during experiment creation)gwo:experimentNotes—user-created notes field.
Limited to 2000 characters.gwo:analyticsAccountId—the account ID that owns
this experiment. (read-only; may be set during experiment creation) gwo:status—the current status of the experiment:
New, Running, Paused, or Finished.gwo:coverage—the percentage of total traffic
to include in the experiment.gwo:numAbPageVariations—the number of page variations
in this experiment (A/B experiments only). (read-only)gwo:numSections—the number of sections in the experiment
(multivariate experiments only). (read-only)gwo:numCombinations—the number of combinations in the experiment.
(read-only)gwo:sourceExperimentId—the experiment ID of
which this experiment is a copy or follow-up. (read-only; may be
set during experiment creation) gwo:verificationCombo—for follow-up experiments,
the combination being verified against the original.
(read-only; may be set during experiment creation) gwo:verificationComboCoverage—for follow-up
experiments, the percentage of traffic to send to the verification
combo. (read-only, may be set during experiment creation)gwo:autoPruneMode—the auto-prune setting for
this experiment: None, Conservative, Normal or
Aggressive.
gwo:controlScript—the control script that should
be placed at the top of any webpage in this experiment. (read-only)gwo:trackingScript—the tracking script that should be placed
at the bottom of any webpage in this experiment. (read-only)gwo:conversionScript—the conversion script that
should be called when a visitor converts. (read-only)gwo:testUrl—the test page URL (as entered by
the user) for display in Website Optimizer UI. Note that this
is a link element. That
is, instead of adding <gwo:testUrl>http://my.url.com</gwo:testUrl> to
the entry, you add <link rel='gwo:testUrl' type='text/html'
href='http://my.url.com'
/>.gwo:goalUrl—the goal page url (as entered by
user) for display in Website Optimizer UI. Note that this is
a link element. That
is, instead of adding <gwo:testUrl>http://my.url.com</gwo:testUrl> to
the entry, you add <link rel='gwo:goalUrl' type='text/html'
href='http://my.url.com'
/>.gwo:reportUrl—the link to the report page for
the experiment. (read-only) gwo:configurationUrl—the link to the configuration page for
the experiment. (read-only) The abpagevariations feed returns either:
{abPageVariationId} is
set to the valid page variation ID).This feed is only valid for A/B experiments (e.g. when gwo:experimentType is
set to A/B).
id—a unique URI of the form http://www.google.com/analytics/feeds/websiteoptimizer/experiments/{experimentId}/abpagevariations.title—Page Variation list for experiment #{experimentId}.id —a string that uniquely identifies this page variation
entry. Example: http://www.google.com/analytics/feeds/websiteoptimizer/experiments/{experimentId}/abpagevariations/{abPageVariationId}.title—the name of this variation.gwo:experimentId—the experiment ID for this
A/B experiment. (read-only)gwo:abPageVariationId—the ID for this page variation (0-based).
(read-only)content—the URL for this page variation.The sections feed returns either:
This feed is only valid for multivariate experiments (gwo:experimentType = "Multivariate").
id—a unique URI of the form http://www.google.com/analytics/feeds/websiteoptimizer/experiments/{experimentId}/sections.title—Section list for experiment #{experimentId}.id—a string that uniquely identifies this section entry.
Example: http://www.google.com/analytics/feeds/websiteoptimizer/experiments/{experimentId}/sections/{sectionId}.title—the name of this section.gwo:experimentId—the experiment id for this multivariate
experiment. (read-only)gwo:sectionId—the id for this section (0-based). (read-only)gwo:numVariations—the number of variations for this section.
(read-only)gwo:sectionBeginScript—the script snippet to place before
this section. (read-only)gwo:sectionEndScript—the script snippet to place after this
section (read-only)The variations feed returns either:
{variationId} is
set to the valid variation ID)This feed is only valid for multivariate experiments (e.g. where gwo:experimentType is set to Mult). ivariate
id —a unique URI of the form http://www.google.com/analytics/feeds/websiteoptimizer/experiments/{experimentId}/sections/{sectionId}/variations.title—Variation list for section #{sectionId} of experiment
#{experimentId}.id—a string that uniquely identifies this variation entry.
Example: http://www.google.com/analytics/feeds/websiteoptimizer/experiments/{experimentId}/sections/{sectionId}/variations/{variationId}.gwo:experimentId—the experiment ID for this
multivariate experiment. (read-only)gwo:sectionId—the ID for the section that owns
this variation (0-based). (read-only)gwo:variationId—the id for this variation (0-based). (read-only)content—the content for this variation.The combinations feed returns either:
{combinationId} is
set to the valid combination id (e.g., 18) or combination info string
(e.g., 0-1-1)id—a unique URI of the form http://www.google.com/analytics/feeds/websiteoptimizer/experiments/{experimentId}/combinations.title—Combination list for experiment #{experimentId}.id —a string that uniquely identifies this combination entry.
Example: http://www.google.com/analytics/feeds/websiteoptimizer/experiments/{experimentId}/combinations/{combinationId}.gwo:experimentId—the experiment id for this experiment. (read-only)gwo:comboId—the id of this combination (0-based;
read-only)gwo:comboString—the combination info string,
which consists of a set of variation indices for each section. For
example, 0-1-1.
(read-only)gwo:comboActive—true if the combination is active; false if it has been pruned.