Skip to main content

TypeAlias.CampaignStats

type CampaignStats = {
activated: number;
conversionRate: number;
currency: "EUR" | "USD";
excludedFrequencyCap: number;
excludedNoCard: number;
excludedOptOut: number;
failed: number;
notified: number;
revenueCents: number;
sent: number;
};

Aggregated outcome of a campaign once it has started sending, returned by the campaign stats endpoint: a per-status delivery tally plus a revenue-free conversion proxy. Computed live, so figures keep moving until the campaign is finished; all zero before sending starts.

Type Declaration

NameType
activatednumber
conversionRatenumber
currency"EUR"
excludedFrequencyCapnumber
excludedNoCardnumber
excludedOptOutnumber
failednumber
notifiednumber
revenueCentsnumber
sentnumber