--- updatedAt: 2025-04-28T12:09:26.000Z agentTools: projectIndex: https://developers.wingify.com/v2/llms.txt --- # Campaign resource representation
Property Type Description Editable
id integer Campaign Id No
name string Campaign Name Yes
type string Campaign type Valid values include `ab`, `multivariate`, `heatmap`, `conversion`, `split` Yes
status string Campaign status Yes
createdOn timestamp Campaign creation time No
labels Nested Object See CampaignLabel resource Yes
percentTraffic float Percentage traffic allocated to the campaign Yes
isCrossDomainEnabled boolean Tracking conversions across multiple domains Yes
createdBy NestedObject Contains the information of user who created the campaign
createdBy.id integer User Id No
createdBy.name string User name No
createdBy.imageUrl link User gravatar link No
urls Nested Object Urls to be included in the campaign Yes
urls.\{index}.type String Url type Valid values include `url`,`startsWith`, `endsWith`,`contains`,`pattern`,`regex` Yes
urls.\{index}.value Link Url value Yes
excludedUrls Nested Object Urls to be excluded in the campaign Yes
excludedUrls.\{index}.type String Url type Yes
excludedUrls.\{index}.value Link Url value Yes
primaryUrl link Url on which test needs to be created Yes
integrations Nested Object See integration resource for more details Yes
thresholds Nested Object Thresholds for campaign data collection
thresholds.winningPercent Float Threshold for winning variation Yes
thresholds.losingPercent Float Threshold for losing variation Yes
thresholds.visitors integer Threshold for number of visitors Yes
device string Device for which the campaign was created No
variations Nested Object See variation resource for details Yes
sections Nested Object See section resource for details Yes
goals Nested Object See goal resource for details Yes
dataIntervalRange Nested Object Date Range for collected campaign range
dataIntervalRange.intervalSize timestamp Size of intervals for which data is shown No
dataIntervalRange.startTime timestamp Campaign data start time which is selected No
dataIntervalRange.endTime timestamp Campaign data end time which is selected No
dataIntervalRange.limitingStartTime timestamp Campaign data start time for which overall data is collected No
dataIntervalRange.limitingEndTime timestamp Campaign data end time for which overall data is collected No
variationGoalData Nested Object Campaign data for each variation-goal combination No
variationGoalData.variation integer Variation Id No
variationGoalData.goal integer Goal Id No
variationGoalData.aggregated Nested Object Aggregated data for variation-goal combination No
variationGoalData.aggregated.visitorCount integer visitor count No
variationGoalData.aggregated.conversionCount integer conversion count No
variationGoalData.aggregated.conversionRate float conversion rate No
variationGoalData.aggregated.standardError float standard error No
variationGoalData.aggregated.totalRevenue integer total revenue if revenue type goal is selected No
variationGoalData.aggregated.revenuePerVisitor float revenue per visitor No
variationGoalData.aggregated.revenuePerConversion float revenue per conversion No
variationGoalData.aggregated.revenuePerVisitorStandardError float revenue per visitor standard error No
variationGoalData.aggregated.revenuePerConversionStandardError float revenue per conversion standard error No
variationGoalData.isLoser boolean if variation-goal combination is loser No
variationGoalData.isWinner boolean if variation-goal combination is winner No
variationGoalData.intervalWise Nested Object Interval wise data for variation-goal combination No
variationGoalData.intervalWise.\{index}.interval timestamp interval time No
variationGoalData.intervalWise.\{index}.visitorCount integer visitor count No
variationGoalData.intervalWise.\{index}.conversionCount integer conversion count No
variationGoalData.intervalWise.\{index}.totalCount integer total count No
stats.conversionRate integer Conversion rate for the campaign (Default :0.05) Yes
stats.certaintyMode integer Certainty Modes\ High Certainty: 0.01\ Balanced Mode: 0.075\ Quick Learnings: 0.20 (Default : 0.01) Yes
stats.expectedMonthlyVisitors integer Monthly expected Visitors on the website whose campaign is created (Default : 300000) Yes
stats.expectedRevenuePerVisitor integer Expected Revenue per visitor (Default : 2) Yes
stats.liftInConversionRate integer Expected lift in Improvement Rate to be achieved by this campaign\ (Default : 0.05) Yes