Skip to content

Latest commit

 

History

History
37 lines (25 loc) · 2.38 KB

File metadata and controls

37 lines (25 loc) · 2.38 KB

ApplicationCampaignAnalytics

Properties

Name Type Description Notes
startTime OffsetDateTime The start of the aggregation time frame in UTC.
endTime OffsetDateTime The end of the aggregation time frame in UTC.
campaignId Long The ID of the campaign.
campaignName String The name of the campaign.
campaignTags List<String> A list of tags for the campaign.
campaignState CampaignStateEnum The state of the campaign. Note: A disabled or archived campaign is not evaluated for rules or coupons.
totalRevenue AnalyticsDataPointWithTrendAndInfluencedRate The total, pre-discount value of all items purchased in a customer session. [optional]
sessionsCount AnalyticsDataPointWithTrendAndInfluencedRate The number of all closed sessions. The `influenced` value includes only sessions with at least one applied effect. [optional]
avgItemsPerSession AnalyticsDataPointWithTrendAndUplift The number of items from sessions divided by the number of sessions. The `influenced` value includes only sessions with at least one applied effect. [optional]
avgSessionValue AnalyticsDataPointWithTrendAndUplift The average customer session value, calculated by dividing the revenue value by the number of sessions. The `influenced` value includes only sessions with at least one applied effect. [optional]
totalDiscounts AnalyticsDataPointWithTrend The total value of discounts given for cart items in influenced sessions. [optional]
couponsCount AnalyticsDataPointWithTrend The number of times a coupon was successfully redeemed in influenced sessions. [optional]

Enum: CampaignStateEnum

Name Value
EXPIRED "expired"
SCHEDULED "scheduled"
RUNNING "running"
DISABLED "disabled"
ARCHIVED "archived"
STAGED "staged"