get_experiment: Gets a experiment to which the user has access to

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

Description

Gets a experiment to which the user has access to

Usage

get_experiment(account.id, webproperty.id, profile.id, experiment.id, token)

Arguments

account.id	integer or character. Account ID to retrieve the experiment for.
webproperty.id	integer or character. Web property ID to retrieve the experiment for.
profile.id	integer or character. View (Profile) ID to retrieve the experiment for.
experiment.id	integer or character. Experiment ID to retrieve the experiment for.
token	Token2.0 class object with a valid authorization data.

Value

An Analytics experiment resource.

id	Experiment ID. Required for patch and update.
kind	Resource type for an Analytics experiment.
self.link	Link for this experiment.
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.
internal.webproperty.id	Internal ID for the web property to which this experiment belongs.
profile.id	View (Profile) ID to which this experiment belongs.
name	Experiment name. This field is required when creating an experiment.
description	Notes about this experiment.
created	Time the experiment was created.
updated	Time the experiment was last modified.
objective.metric	The metric that the experiment is optimizing.
status	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.
winner.found	Boolean specifying whether a winner has been found for this experiment.
start.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.
end.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.
reason.experiment.ended	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.
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.
minimum.experiment.length.in.days	An integer number in [3, 90]. Specifies the minimum length of the experiment. Can be changed for a running experiment.
traffic.coverage	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.
equal.weighting	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.
snippet	The snippet of code to include on the control page(s).
serving.framework	The framework used to serve the experiment variations and evaluate the results.
editable.in.ga.ui	If true, the end user will be able to edit the experiment via the Google Analytics user interface.
parent.link	Parent link for an experiment. Points to the view (profile) to which this experiment belongs.
variations	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.
variations.name	The name of the variation.
variations.url	The URL of the variation.
variations.status	Status of the variation.
variations.weight	Weight that this variation should receive.
variations.won	True if the experiment has ended and this variation performed (statistically) significantly better than the original.
parent.link.type	Value is "analytics#profile".
parent.link.href	Link to the view (profile) to which this experiment belongs.

References

Management API - Experiments

See Also

authorize

Other Management API: get_custom_dimension; get_custom_metric; get_filter; get_goal; get_profile; get_unsampled_report; get_webproperty; list_accounts; list_custom_dimensions; list_custom_metrics; list_custom_sources; list_experiments; 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.