Skip to main content

Analytics events

Updated this week

Events

The following Treefort analytics events are available via GA4 and the Kafka integration.

Event name

Description

Parameters

tf_checkout_complete

Triggered when a user finishes the checkout flow.

Checkout

tf_checkout_start

Triggered when a user starts the checkout flow.

Checkout

tf_contact

Triggered when a user submits the contact form.

None

tf_play_time_milestone

Triggered when a user reaches a new milestone with regards to how much time they have spent playing a piece of content.

Play milestone

tf_play_position_milestone

Triggered when a user reaches a new milestone with regards to how far into a piece of content they have played.

Play milestone

tf_play_progress

Triggered intermittently while a user plays a piece of content.

Play progress

tf_play_request

Triggered when a user requests to play a piece of content.

Play request

tf_read_position_milestone

Triggered when a user reaches a new milestone with regards to how far into a piece of content they have read.

Read milestone

tf_read_progress

Triggered intermittently while a user reads a piece of content.

Read progress

tf_read_request

Triggered when a user requests to read a piece of content.

Read request

tf_screen_view

Triggered when a user visits a new screen in the app.

Screen

tf_share

Triggered when a user shares a page in the app using the built-in share button.

Screen

tf_search

Triggered when a user searches in the app.

Search

tf_subscription_activated

Triggered when a new subscription or a previously deactivated is activated.

Subscription activated

tf_subscription_renewed

Triggered when a subscription is renewed.

Subscription renewed

tf_subscription_canceled

Triggered when a subscription is canceled voluntarily by the user. In most circumstances canceled subscriptions will remain active until their next renewal date.

Subscription

tf_subscription_uncanceled

Triggered when a user revokes their request to cancel their subscription before the subscription is deactivated.

Subscription

tf_subscription_deactivated

Triggered when a subscription is deactivated and can no longer be used to access benefits.

Subscription

tf_user_registered

Triggered when a user creates a new account.

User

tf_user_authenticated

Triggered when a user signs in with an existing account.

User

Parameters

Checkout

Parameter name

Type

Description

tf_subscription_plan_id

number

The unique Treefort ID of the subscription plan being checked out.

tf_subscription_plan_provider

"playStore", "appStore", "stripe", "webPayment", "groupMembership"

The provider of the subscription plan being checked out.

tf_subscription_free_trial

boolean

Whether a free trial is being offered.

tf_currency

string

The currency being presented to the user.

tf_price

number

The price being presented to the user.

tf_checkout_code

string

The promo code, coupon code, or group membership code being applied.

tf_content_id

number

The locked content from which the user entered the checkout flow.

tf_recomm_id

string

The recommended item from which the user entered the checkout flow.

Play milestone

Parameter name

Type

Description

tf_content_id

number

The unique Treefort ID of the content being played.

tf_content_title

string

The title of the content being played.

tf_content_type

"video", "book", "podcast", "album"

The type of the content being played.

tf_content_sku

string

The SKU of the content being played.

tf_content_podcast_episode

number

The number of the podcast episode being played.

tf_play_mode

"watch", "listen"

Whether the user is watching to or listening to the media.

tf_play_track

number

The zero-based index of the track the user is listening to.

tf_playback_rate

number

The rate at which the media is playing.

tf_play_position

number

The user's current position in the content as a whole (all tracks) in milliseconds.

tf_duration

number

The total duration of the content as a whole (all tracks) in milliseconds.

tf_progress_percent

number

The user's current position in the content as a whole (all tracks) as a percentage (0-1).

tf_milestone_percent

10, 25, 50, 75, 90

The percent milestone being logged.

Play progress

Parameter name

Type

Description

tf_content_id

number

The unique Treefort ID of the content being played.

tf_content_title

string

The title of the content being played.

tf_content_type

"video", "book", "podcast", "album"

The type of the content being played.

tf_content_sku

string

The SKU of the content being played.

tf_content_podcast_episode

number

The number of the podcast episode being played.

tf_play_mode

"watch", "listen"

Whether the user is watching to or listening to the media.

tf_play_track

number

The zero-based index of the track the user is listening to.

tf_playback_rate

number

The rate at which the media is playing.

tf_play_position

number

The user's current position in the content as a whole (all tracks) in milliseconds.

tf_duration

number

The total duration of the content as a whole (all tracks) in milliseconds.

tf_progress_percent

number

The user's current position in the content as a whole (all tracks) as a percentage (0-1).

tf_engagement_time

number

The real-world time in milliseconds that the user spent engaging with the content during this specific progress event.

tf_play_time

number

The media time in milliseconds that the user played through during this specific progress event. This is roughly equivalent to engagement time multiplied by playback rate.

Play request

Parameter name

Type

Description

tf_content_id

number

The unique Treefort ID of the content being played.

tf_content_title

string

The title of the content being played.

tf_content_type

"video", "book", "podcast", "album"

The type of the content being played.

tf_content_sku

string

The SKU of the content being played.

tf_content_podcast_episode

number

The number of the podcast episode being played.

tf_play_mode

"watch", "listen"

Whether the user is watching to or listening to the media.

tf_play_track

number

The zero-based index of the track the user is listening to.

tf_playback_rate

number

The rate at which the media is playing.

tf_play_position

number

The user's current position in the content as a whole (all tracks) in milliseconds.

tf_duration

number

The total duration of the content as a whole (all tracks) in milliseconds.

tf_progress_percent

number

The user's current position in the content as a whole (all tracks) as a percentage (0-1).

Read milestone

Parameter name

Type

Description

tf_content_id

number

The unique Treefort ID of the content being read.

tf_content_title

string

The title of the content being read.

tf_content_type

"ebook", "webEmbed"

The type of the content being read.

tf_content_sku

string

The SKU of the content being read.

tf_progress_percent

number

The user's current position in the content as a percentage (0-1).

tf_milestone_percent

10, 25, 50, 75, 90

The percent milestone being logged.

Read progress

Parameter name

Type

Description

tf_content_id

number

The unique Treefort ID of the content being read.

tf_content_title

string

The title of the content being read.

tf_content_type

"ebook", "webEmbed"

The type of the content being read.

tf_content_sku

string

The SKU of the content being read.

tf_progress_percent

number

The user's current position in the content as a percentage (0-1).

tf_engagement_time

number

The real-world time in milliseconds that the user spent engaging with the content during this specific progress event.

tf_words_visible

number

The number of words that were visible during this specific progress event

Read request

Parameter name

Type

Description

tf_content_id

number

The unique Treefort ID of the content being read.

tf_content_title

string

The title of the content being read.

tf_content_type

"ebook", "webEmbed"

The type of the content being read.

tf_content_sku

string

The SKU of the content being read.

tf_progress_percent

number

The user's current position in the content as a percentage (0-1).

Screen

Parameter name

Type

Description

tf_screen_path

string

The path of the current screen.

tf_screen_title

string

The title of the current screen.

tf_screen_page_id

string

The page ID if viewing a custom page.

tf_screen_tab_id

string

The ID of the currently active app.

tf_content_id

number

The content ID if viewing content.

tf_content_type

"album", "book", "podcast", "video", "webEmbed", "ebook", "article"

The content type if viewing content.

tf_content_sku

string

The content SKU if viewing content.

tf_content_title

string

The content title if viewing content.

tf_collection_id

number

The collection ID if viewing a collection.

tf_collection_type

"tag", "blog"

The collection type if viewing a collection.

tf_collection_title

string

The collection title if viewing a collection.

tf_recomm_id

string

The recommendation ID if this screen was arrived at by recommendation.

Search

Parameter name

Type

Description

tf_search_outcome

"success", "abandoned"

Whether the search was successful (the user selected a result) or abandoned (the user did not select a result).

tf_search_query

string

The query entered by the user.

tf_search_results_count

number

The number of results shown to the user in response to their query.

tf_search_result_id

number

The unique Treefort ID of the result selected by the user (if the search was successful).

tf_search_result_type

"album", "book", "podcast", "video", "webEmbed", "ebook", "article", "song", "podcastEpisode", "tag", "blog", "videoSeries"

The type of the result selected by the user (if the search was successful).

tf_content_type

"album", "book", "podcast", "video", "webEmbed", "ebook", "article"

The content type if viewing content.

Subscription activated

Parameter name

Type

Description

tf_subscription_id

number

The unique Treefort ID of the subscription.

tf_subscription_plan_id

number

The unique Treefort ID of the subscription plan.

tf_subscription_plan_provider

"playStore", "appStore", "stripe", "webPayment", "groupMembership"

The provider of the subscription plan.

tf_subscription_free_trial

boolean

Whether a free trial is active.

tf_currency

string

The default currency of the subscription plan.

tf_price

number

The current price of the subscription plan.

tf_checkout_code

string

The promo code, coupon code, or group membership code that was applied to the subscription.

tf_transaction_id

string

The provider-specific transaction ID for the subscription.

Subscription renewed

Parameter name

Type

Description

tf_subscription_id

number

The unique Treefort ID of the subscription.

tf_subscription_plan_id

number

The unique Treefort ID of the subscription plan.

tf_subscription_plan_provider

"playStore", "appStore", "stripe", "webPayment", "groupMembership"

The provider of the subscription plan.

tf_subscription_free_trial

boolean

Whether a free trial is active.

tf_currency

string

The default currency of the subscription plan.

tf_price

number

The current price of the subscription plan.

tf_transaction_id

string

The provider-specific transaction ID for the subscription.

Subscription

Parameter name

Type

Description

tf_subscription_id

number

The unique Treefort ID of the subscription.

tf_subscription_plan_id

number

The unique Treefort ID of the subscription plan.

tf_subscription_plan_provider

"playStore", "appStore", "stripe", "webPayment", "groupMembership"

The provider of the subscription plan.

tf_subscription_free_trial

boolean

Whether a free trial is active.

tf_currency

string

The default currency of the subscription plan.

tf_price

number

The current price of the subscription plan.

User

Parameter name

Type

Description

tf_user_id

string

The user's unique Treefort ID.

Did this answer your question?