TRACKING.md

Usage Tracking

Pinterest for WooCommerce implements usage tracking, based on the native WooCommerce Usage Tracking, and is only enabled when WooCommerce Tracking is enabled.

When a store opts in to WooCommerce usage tracking and uses Pinterest for WooCommerce, they will also be opted in to the tracking added by Pinterest for WooCommerce.

What is tracked

As in WooCommerce core, only non-sensitive data about how a store is set up and managed is tracked. We do not track or store personal data from your clients.

wcadmin_pfw_account_connect_button_click

Clicking on "Connect" Pinterest account button.

Emitters

• AccountConnection

wcadmin_pfw_account_convert_button_click

Clicking on "… convert your personal account" button.

Emitters

• SetupAccount

wcadmin_pfw_account_create_button_click

Clicking on "… create a new Pinterest account" button.

Emitters

• SetupAccount

wcadmin_pfw_account_disconnect_button_click

Clicking on "Disconnect" Pinterest account button.

Properties

name	type	description
context	string	'settings' | 'wizard' In which context it was used?

Emitters

• AccountConnection with the given { context }

wcadmin_pfw_ads_manager_link_click

Clicking on the "Pinterest ads manager" link.

Emitters

• SyncState

wcadmin_pfw_ads_credits_success_notice

Closing the Ads Credits notice on Catalog Page.

Emitters

• AdCreditsNotice

wcadmin_pfw_ads_billing_details_link_click

Clicking on the "add your billing details" link.

Emitters

• AdCreditsNotice

wcadmin_pfw_business_account_connect_button_click

Clicking on "Connect" business account button.

Emitters

• BusinessAccountSelection

wcadmin_pfw_business_account_create_button_click

Clicking on "Create business account" button.

Emitters

• BusinessAccountSelection

wcadmin_pfw_documentation_link_click

Clicking on an external documentation link.

Properties

name	type	description
link_id	string	Identifier of the link.
context	string	'settings' | 'welcome-section' | 'wizard' | 'ads-credits-terms-and-conditions' In which context the link was placed?
href	string	Href to which the user was navigated to.

Emitters

• documentationLinkProps on click, with given linkId and context.
• ClaimWebsite with { link_id: 'claim-website', context: props.view }
• SetupAccount
  • with { link_id: 'ad-guidelines', context: props.view }
  • with { link_id: 'merchant-guidelines', context: props.view }
• SetupTracking
  • with { link_id: 'ad-guidelines', context: 'wizard'|'settings' }
  • with { link_id: 'ad-data-terms', context: 'wizard'|'settings' }
  • with { link_id: 'ad-terms-of-service', context: 'wizard'|'settings' }
  • with { link_id: 'install-tag', context: 'wizard'|'settings' }
  • with { link_id: 'automatic-enhanced-match', context: 'wizard'|'settings' }
• SetupPins
  • with { link_id: 'ads-manager', context: 'settings' }
  • with { link_id: 'enhanced-match', context: 'settings' }
• WelcomeSection with { link_id: 'terms-of-service', context: 'welcome-section' }
• TermsAndConditionsModal
  • with { link_id: 'terms-of-service', context: 'ads-credits-terms-and-conditions' }
    • with { link_id: 'privacy-policy', context: 'ads-credits-terms-and-conditions' }
    • with { link_id: 'advertising-services-agreement', context: 'ads-credits-terms-and-conditions' }
• FormattedReasons
  • with { link_id: 'merchant-guidelines', context: 'merchant-disapproval-reasons' }

wcadmin_pfw_domain_verify_failure

Triggered when domain verification fails.

Properties

name	type	description
step	string	Identifier of the step when verification failed.

Emitters

• ClaimWebsite

wcadmin_pfw_domain_verify_success

Triggered when a site is successfully verified.

Emitters

• ClaimWebsite

wcadmin_pfw_get_started_faq

Clicking on getting started page faq item to collapse or expand it.

Properties

name	type	description
action	string	'expand' | 'collapse' What action was initiated.
question_id	string	Identifier of the clicked question.

Emitters

• FaqQuestion whenever the FAQ is toggled.

wcadmin_pfw_get_started_notice_link_click

Clicking on the link inside the notice.

Properties

name	type	description
link_id	string	Identifier of the link.
context	string	What action was initiated.
href	string	Href to which the user was navigated to.

Emitters

• PrelaunchNotice { context: 'pinterest-landing', link_id: 'prelaunch-notice' }
• UnsupportedCountryNotice with { context: 'pinterest-landing', linkId: 'ads-availability' | 'unsupported-country-link' }

wcadmin_pfw_modal_closed

Closing a modal.

Properties

name	type	description
name	string	Which modal is it?
context	string	'settings' | 'wizard' | 'landing-page' | 'catalog-sync' In which context it was used?
action	string	confirm - When the final "Yes, I'm sure" button is clicked. dismiss - When the modal is dismissed by clicking on "x", "cancel", overlay, or by pressing a keystroke.

Emitters

• AccountConnection with { name: 'account-disconnection', … }
• LandingPageApp.AdsCreditSection with { name: 'ads-credits-terms-and-conditions', … }
• CatalogSync with { name: 'ads-credits-onboarding', … }
• SetupAccount with { name: 'ads-credits-terms-and-conditions', … }

wcadmin_pfw_modal_open

Opening a modal.

Properties

name	type	description
name	string	Which modal is it?
context	string	'settings' | 'wizard' | 'landing-page' | 'catalog-sync' In which context it was used?

Emitters

• AccountConnection with { name: 'account-disconnection', … }
• LandingPageApp.AdsCreditSection with { name: 'ads-credits-terms-and-conditions', … }
• CatalogSync with { name: 'ads-credits-onboarding', … }
• SetupAccount with { name: 'ads-credits-terms-and-conditions', … }

wcadmin_pfw_save_changes_button_click

Clicking on "… Save changes" button.

Properties

name	type	description
enable_debug_logging	boolean	Indicates if Enable debug logging option is checked
enhanced_match_support	boolean	Indicates if Enhanced Match Support option is checked
automatic_enhanced_match_support	boolean	Indicates if Automatic Enhanced Match Support option is checked
erase_plugin_data	boolean	Indicates if Erase Plugin Data option is checked
product_sync_enabled	boolean	Indicates if Enable Product Sync option is checked
rich_pins_on_posts	boolean	Indicates if Add Rich Pins for Posts option is checked
rich_pins_on_products	boolean	Indicates if Add Rich Pins for Products option is checked
save_to_pinterest	boolean	Indicates if Save to Pinterest option is checked
track_conversions	boolean	Indicates if Track Conversion option is checked
context	string	The context in which the event is recorded

Emitters

• SaveSettingsButton with { context: view, … }

wcadmin_pfw_setup

Triggered on events during setup, like starting, ending, or navigating between steps.

Properties

name	type	description
target	string	Setup phase that the user navigates to.
trigger	string	UI element that triggered the action, e.g. wizard-stepper or get-started button.

Emitters

• SetupTracking
  • with { target: 'complete', trigger: 'setup-tracking-complete' } when "Complete setup" button is clicked.
  • with { target: 'fetch-tags' | 'fetch-advertisers', trigger: 'setup-tracking-try-again' } when "Try again" button is clicked.
• WelcomeSection with { target: 'onboarding', trigger: 'get-started' } when "Get started" button is clicked for incomplete setup.
• WizardApp
  • with { target: 'setup-account' | 'claim-website' | 'setup-tracking', trigger: 'wizard-stepper' } when wizard's header step is clicked.
  • with { target: 'claim-website' , trigger: 'setup-account-continue' } when continue button is clicked.
  • with { target: 'setup-tracking', trigger: 'claim-website-continue' } when continue button is clicked.