class Iterable::Experiments
Interact with /experiments API endpoints
@example Creating experiments endpoint object
# With default config templates = Iterable::Experiments.new [1, 2, 3] templates.get # With custom config conf = Iterable::Config.new(token: 'new-token') templates = Iterable::Experiments.new([1, 2, 3], config)
Attributes
experiment_ids[R]
Public Class Methods
new(experiment_ids = [], conf = nil)
click to toggle source
Initialize Experiments
with an array of experiment ids
@param experiment_ids
[Array] Array of experiment_id Integers @param conf [Iterable::Config] A config to optionally pass for requests
@return [Iterable::Experiments]
Calls superclass method
Iterable::ApiResource::new
# File lib/iterable/experiments.rb, line 24 def initialize(experiment_ids = [], conf = nil) @experiment_ids = experiment_ids super conf end
Public Instance Methods
metrics(campaign_ids = [], start_time = nil, end_time = nil)
click to toggle source
Get metrics for experiments
@params campaign_ids [Array] Array of campaignIds to optionally query for @param start_time [Date|Time] Start of metrics to query for @param end_time [Date|Time] End of metrics to query for
@return [Iterable::Response] A response object
# File lib/iterable/experiments.rb, line 38 def metrics(campaign_ids = [], start_time = nil, end_time = nil) params = { experimentId: @experiment_ids, campaignId: campaign_ids } if start_time params[:startTime] = start_time.to_date.strftime(Iterable::DATE_FORMAT) params[:endTime] = end_time.to_date.strftime(Iterable::DATE_FORMAT) end Iterable.request(conf, '/experiments/metrics', params).get end