| id |
Integer |
Unique ID for this entity. |
|
| created |
OffsetDateTime |
The exact moment this entity was created. |
|
| applicationId |
Integer |
The ID of the application that owns this entity. |
|
| userId |
Integer |
The ID of the user associated with this entity. |
|
| name |
String |
A user-facing name for this campaign. |
|
| description |
String |
A detailed description of the campaign. |
|
| startTime |
OffsetDateTime |
Timestamp when the campaign will become active. |
[optional] |
| endTime |
OffsetDateTime |
Timestamp when the campaign will become inactive. |
[optional] |
| attributes |
Object |
Arbitrary properties associated with this campaign. |
[optional] |
| state |
StateEnum |
A disabled or archived campaign is not evaluated for rules or coupons. |
|
| activeRulesetId |
Integer |
ID of Ruleset this campaign applies on customer session evaluation. |
[optional] |
| tags |
List<String> |
A list of tags for the campaign. |
|
| features |
List<FeaturesEnum> |
The features enabled in this campaign. |
|
| couponSettings |
CodeGeneratorSettings |
|
[optional] |
| referralSettings |
CodeGeneratorSettings |
|
[optional] |
| limits |
List<LimitConfig> |
The set of budget limits for this campaign. |
|
| campaignGroups |
List<Integer> |
The IDs of the campaign groups this campaign belongs to. |
[optional] |
| couponRedemptionCount |
Integer |
Number of coupons redeemed in the campaign. |
[optional] |
| referralRedemptionCount |
Integer |
Number of referral codes redeemed in the campaign. |
[optional] |
| discountCount |
BigDecimal |
Total amount of discounts redeemed in the campaign. |
[optional] |
| discountEffectCount |
Integer |
Total number of times discounts were redeemed in this campaign. |
[optional] |
| couponCreationCount |
Integer |
Total number of coupons created by rules in this campaign. |
[optional] |
| customEffectCount |
Integer |
Total number of custom effects triggered by rules in this campaign. |
[optional] |
| referralCreationCount |
Integer |
Total number of referrals created by rules in this campaign. |
[optional] |
| addFreeItemEffectCount |
Integer |
Total number of times the add free item effect can be triggered in this campaign. |
[optional] |
| awardedGiveawaysCount |
Integer |
Total number of giveaways awarded by rules in this campaign. |
[optional] |
| createdLoyaltyPointsCount |
BigDecimal |
Total number of loyalty points created by rules in this campaign. |
[optional] |
| createdLoyaltyPointsEffectCount |
Integer |
Total number of loyalty point creation effects triggered by rules in this campaign. |
[optional] |
| redeemedLoyaltyPointsCount |
BigDecimal |
Total number of loyalty points redeemed by rules in this campaign. |
[optional] |
| redeemedLoyaltyPointsEffectCount |
Integer |
Total number of loyalty point redemption effects triggered by rules in this campaign. |
[optional] |
| callApiEffectCount |
Integer |
Total number of webhooks triggered by rules in this campaign. |
[optional] |
| reservecouponEffectCount |
Integer |
Total number of reserve coupon effects triggered by rules in this campaign. |
[optional] |
| lastActivity |
OffsetDateTime |
Timestamp of the most recent event received by this campaign. |
[optional] |
| updated |
OffsetDateTime |
Timestamp of the most recent update to the campaign's property. Updates to external entities used in this campaign are not registered by this property, such as collection or coupon updates. |
[optional] |
| createdBy |
String |
Name of the user who created this campaign if available. |
[optional] |
| updatedBy |
String |
Name of the user who last updated this campaign if available. |
[optional] |
| templateId |
Integer |
The ID of the Campaign Template this Campaign was created from. |
[optional] |