list_experiments: Lists experiments to which the user has access to

In jdeboer/RGA-1: A Google Analytics API Client

Description

Lists experiments to which the user has access to

Usage

list_experiments(account.id, webproperty.id, profile.id, start.index = NULL,
  max.results = NULL, token)

Arguments

account.id	Account ID to retrieve experiments for.
webproperty.id	Web property ID to retrieve experiments for.
profile.id	View (Profile) ID to retrieve experiments for.
start.index	integer. An index of the first experiment to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
max.results	integer. The maximum number of experiments to include in this response.
token	Token2.0 class object with a valid authorization data.

Value

An experiment collection lists Analytics experiments to which the user has access. Each view (profile) can have a set of experiments. Each resource in the Experiment collection corresponds to a single Analytics experiment.

id	Experiment ID. Required for patch and update. Disallowed for create.
account.id	Account ID to which this experiment belongs.
webproperty.id	Web property ID to which this experiment belongs. The web property ID is of the form UA-XXXXX-YY.
profile.id	View (Profile) ID to which this experiment belongs.
name	Experiment name. This field may not be changed for an experiment whose status is ENDED.
description	Notes about this experiment.
objective.metric	The metric that the experiment is optimizing.
optimization.type	Whether the objectiveMetric should be minimized or maximized.
status	Experiment status.
winner.found	Boolean specifying whether a winner has been found for this experiment.
rewrite.variation.urls.as.original	Boolean specifying whether variations URLS are rewritten to match those of the original.
winner.confidence.level	A floating-point number between 0 and 1. Specifies the necessary confidence level to choose a winner.
start.time	The starting time of the experiment (the time the status changed from READY_TO_RUN to RUNNING).
end.time	The ending time of the experiment (the time the status changed from RUNNING to ENDED).
minimum.experiment.length.in.days	An integer number in [3, 90]. Specifies the minimum length of the experiment.
reason.experiment.ended	Why the experiment ended.
editable.in.ga.ui	If true, the end user will be able to edit the experiment via the Google Analytics user interface.

References

Management API - Experiments

See Also

authorize

Other Management API: get_custom_dimension; get_custom_metric; get_experiment; get_filter; get_goal; get_profile; get_unsampled_report; get_webproperty; list_accounts; list_custom_dimensions; list_custom_metrics; list_custom_sources; list_filters; list_goals; list_profiles; list_segments; list_unsampled_reports; list_webproperties

jdeboer/RGA-1 documentation built on May 18, 2019, 11:29 p.m.