Campaign resource representation

PropertyTypeDescriptionEditable
idintegerCampaign IdNo
namestringCampaign NameYes
typestringCampaign type

Valid values include ab, multivariate, heatmap, conversion, split
Yes
statusstringCampaign statusYes
createdOntimestampCampaign creation timeNo
labelsNested ObjectSee CampaignLabel resourceYes
percentTrafficfloatPercentage traffic allocated to the campaignYes
isCrossDomainEnabledbooleanTracking conversions across multiple domainsYes
createdByNestedObjectContains the information of user who created the campaign
createdBy.idintegerUser IdNo
createdBy.namestringUser nameNo
createdBy.imageUrllinkUser gravatar linkNo
urlsNested ObjectUrls to be included in the campaignYes
urls.{index}.typeStringUrl type

Valid values include url,startsWith, endsWith,contains,pattern,regex
Yes
urls.{index}.valueLinkUrl valueYes
excludedUrlsNested ObjectUrls to be excluded in the campaignYes
excludedUrls.{index}.typeStringUrl typeYes
excludedUrls.{index}.valueLinkUrl valueYes
primaryUrllinkUrl on which test needs to be createdYes
integrationsNested ObjectSee integration resource for more detailsYes
thresholdsNested ObjectThresholds for campaign data collection
thresholds.winningPercentFloatThreshold for winning variationYes
thresholds.losingPercentFloatThreshold for losing variationYes
thresholds.visitorsintegerThreshold for number of visitorsYes
devicestringDevice for which the campaign was createdNo
variationsNested ObjectSee variation resource for detailsYes
sectionsNested ObjectSee section resource for detailsYes
goalsNested ObjectSee goal resource for detailsYes
dataIntervalRangeNested ObjectDate Range for collected campaign range
dataIntervalRange.intervalSizetimestampSize of intervals for which data is shownNo
dataIntervalRange.startTimetimestampCampaign data start time which is selectedNo
dataIntervalRange.endTimetimestampCampaign data end time which is selectedNo
dataIntervalRange.limitingStartTimetimestampCampaign data start time for which overall data is collectedNo
dataIntervalRange.limitingEndTimetimestampCampaign data end time for which overall data is collectedNo
variationGoalDataNested ObjectCampaign data for each variation-goal combinationNo
variationGoalData.variationintegerVariation IdNo
variationGoalData.goalintegerGoal IdNo
variationGoalData.aggregatedNested ObjectAggregated data for variation-goal combinationNo
variationGoalData.aggregated.visitorCountintegervisitor countNo
variationGoalData.aggregated.conversionCountintegerconversion countNo
variationGoalData.aggregated.conversionRatefloatconversion rateNo
variationGoalData.aggregated.standardErrorfloatstandard errorNo
variationGoalData.aggregated.totalRevenueintegertotal revenue if revenue type goal is selectedNo
variationGoalData.aggregated.revenuePerVisitorfloatrevenue per visitorNo
variationGoalData.aggregated.revenuePerConversionfloatrevenue per conversionNo
variationGoalData.aggregated.revenuePerVisitorStandardErrorfloatrevenue per visitor standard errorNo
variationGoalData.aggregated.revenuePerConversionStandardErrorfloatrevenue per conversion standard errorNo
variationGoalData.isLoserbooleanif variation-goal combination is loserNo
variationGoalData.isWinnerbooleanif variation-goal combination is winnerNo
variationGoalData.intervalWiseNested ObjectInterval wise data for variation-goal combinationNo
variationGoalData.intervalWise.{index}.intervaltimestampinterval timeNo
variationGoalData.intervalWise.{index}.visitorCountintegervisitor countNo
variationGoalData.intervalWise.{index}.conversionCountintegerconversion countNo
variationGoalData.intervalWise.{index}.totalCountintegertotal countNo
stats.conversionRateintegerConversion rate for the campaign (Default :0.05)Yes
stats.certaintyModeintegerCertainty Modes
High Certainty: 0.01
Balanced Mode: 0.075
Quick Learnings: 0.20

(Default : 0.01)
Yes
stats.expectedMonthlyVisitorsintegerMonthly expected Visitors on the website whose campaign is created (Default : 300000)Yes
stats.expectedRevenuePerVisitorintegerExpected Revenue per visitor (Default : 2)Yes
stats.liftInConversionRateintegerExpected lift in Improvement Rate to be achieved by this campaign
(Default : 0.05)
Yes