For the complete documentation index, see llms.txt. This page is also available as Markdown.

Conversion Tracking

Additional details about Conversion Tracking can be found here.

Chartbeat's Conversion Tracking supports the following events:

  • Subscriptions (Paywall)

  • Registrations

  • Newsletter Signups

  • Unsubscribes

  • Offers

  • Surveys

  • Account Creations

  • Downloads

  • Donations

  • Payments

  • Searches

  • Saves

Each conversion type has two overloads — a short form and a long form that adds optional pathOverride, eventLabel, and eventValue parameters.

Call the relevant trackConversion... method with the relevant event state (e.g. shown, complete) to track conversion events when they occur. For example, when a newsletter signup form appears call trackConversionNewsletterWithType:EventTypeNewsletterSignupComplete.

Examples

Short

Long

trackConversionPaywallWithType:

trackConversionPaywallWithType:pathOverride:eventLabel:eventValue:

trackConversionRegistrationWithType:

…:pathOverride:eventLabel:eventValue:

trackConversionNewsletterWithType:

…:pathOverride:eventLabel:eventValue:

trackConversionUnsubscribeWithType:

…:pathOverride:eventLabel:eventValue:

trackConversionOffersWithType:

…:pathOverride:eventLabel:eventValue:

trackConversionSurveysWithType:

…:pathOverride:eventLabel:eventValue:

trackConversionAccountCreationType:

…:pathOverride:eventLabel:eventValue:

trackConversionDownloadsType:

…:pathOverride:eventLabel:eventValue:

trackConversionDonationsType:

…:pathOverride:eventLabel:eventValue:

trackConversionPaymentsType:

…:pathOverride:eventLabel:eventValue:

trackConversionSearchType:

…:pathOverride:eventLabel:eventValue:

trackConversionSavesType:

…:pathOverride:eventLabel:eventValue:

Supported events

Below is a list of the event methods you can pass to the trackConversion... function. You should fire a Chartbeat conversion event from the same category on every page in a single conversion flow.

Subscriptions

Track paywall activity and subscription transactions on your site.

Event Name

Description

Requirement

EventTypePaywallShown

A user was shown a paywall

Required

EventTypePaywallStart

A user started a subscription process

Optional

EventTypePaywallComplete

A user completed a subscription transaction

Required

EventTypePaywallCancel

A user canceled a subscription process

Optional

Registrations

Track registration activity (i.e. users creating an account) on your site.

Event Name

Description

Requirement

EventTypeRegistrationShown

A user viewed a registration screen

Required

EventTypeRegistrationStart

A user started the registration process

Optional

EventTypeRegistrationComplete

A user completed the registration process

Required

EventTypeRegistrationCancel

A user canceled the registration process

Optional

Newsletter Signups

Track newsletter signup activity on your site.

Event Name

Description

Requirement

EventTypeNewsletterSignupShown

A user was shown a newsletter signup option

Required

EventTypeNewsletterSignupStart

A user started a signup process

Optional

EventTypeNewsletterSignupComplete

A user completed a signup process

Required

EventTypeNewsletterSignupCancel

A user canceled a signup process

Optional

Unsubscribes

Track unsubscribe activity on your site.

Event Name

Description

Requirement

EventTypeUnsubscribeShown

A user visited an unsubscribe page

Optional

EventTypeUnsubscribeStart

A user started an unsubscribe flow

Optional

EventTypeUnsubscribeComplete

A user unsubscribed

Required

EventTypeUnsubscribeCancel

A user dismissed an unsubscribe flow

Optional

Offers

Track offer activity on your site.

Event Name

Description

Requirement

EventTypeOfferShown

A user was shown an offer

Optional

EventTypeOfferStart

A user started an offer

Optional

EventTypeOfferComplete

A user completed an offer

Required

EventTypeOfferCancel

A user dismissed an offer

Optional

Surveys

Track survey activity on your site.

Event Name

Description

Requirement

EventTypeSurveyShown

A user was shown a survey

Optional

EventTypeSurveyStart

A user started a survey

Optional

EventTypeSurveyComplete

A user completed a survey

Required

EventTypeSurveyCancel

A user dropped off a survey

Optional

Account Creations

Track user profile activity (e.g. filling out text fields) on your site.

Event Name

Description

Requirement

EventTypeUserProfileShown

A user viewed their profile

Optional

EventTypeUserProfileStart

A user started editing their profile

Optional

EventTypeUserProfileComplete

A user completed editing to their profile

Required

EventTypeUserProfileCancel

A user exited profile-editing mode

Optional

Downloads

Track download activity (e.g. pdf case studies, apps) on your site.

Event Name

Description

Requirement

EventTypeDownloadStart

A user started downloading data

Optional

EventTypeDownloadComplete

A download has completed

Required

EventTypeDownloadCancel

A download was canceled

Optional

Donations

Track donation activity on your site.

Event Name

Description

Requirement

EventTypeDonationShown

An option to donate was shown

Optional

EventTypeDonationStart

A user started the donation process

Optional

EventTypeDonationComplete

A user completed the donation process

Required

EventTypeDonationCancel

A user canceled the donation process

Optional

Payments

Track payment activity on your site (other than payment for a subscription).

Event Name

Description

Requirement

EventTypePaymentStart

A user started a payment process

Optional

EventTypePaymentComplete

A user completed a payment process

Required

EventTypePaymentCancel

A user canceled a payment process

Optional

Searches

Track completed search queries on your site.

Event Name

Description

Requirement

EventTypeSearchComplete

A user performed a search

Required

Saves

Track save activity (e.g. a user added an item to their "Favorites" collection) on your site.

Event Name

Description

Requirement

EventTypeSaveComplete

A user saved an item for future retrieval

Required

Last updated

Was this helpful?