Tracking Approved Email Activity

End users and content admins can track activity generated from a sent Approved Email to gain insight on which kinds of activity and content are most frequently accessed by recipients. Tracking Approved Email activity enables end users to review the efficacy of sent emails and adjust sending habits to best suit each account relationship. Content admins can review Approved Email activity to learn how Approved Email content is being used by recipients, leading to optimization of content.

Email activity is tracked using the following objects:

  • sent_email__v – A Sent Email is generated for every successfully sent or scheduled Approved Email. Sent Emails contain references to the generated HTML content of the email, enabling end users and admins to quickly see the actual sent contents of the email.
  • sent_fragment__v - Includes a list of fragments associated to the sent email
  • email_activity__v – Email Activity records are generated whenever activity is logged on a sent email. These records are associated with sent_email__v records. A Sent Email can reference many Email Activities, but each Email Activity is only associated with one Sent Email.

If a recipient forwards an email to someone else, no event is generated to track that the message was forwarded. Any activities performed in the forwarded email are tracked as if they were performed by the original recipient.

Who can use this feature?

  • Browser, iPad, iPhone Users
  • Users require an Approved Email license
  • Content Admin Users, End Users

Configuring Tracking of Approved Email Activity for

To configure this feature, ensure Configuring Approved Email is complete.

Using Tracking of Approved Email Activity as

Content Admin users can leverage tracking of approved email activity in the following ways:

Due to supporting Universal Linking on the iOS HCP Engage app, click tracking is not supported for Approved Emails containing the following tokens:

  • {{call2__v.cobrowse_url_participant__v}}
  • {{em_attendee__v.webinar_participant_url__v}}
  • {{em_event_speaker__v.webinar_panelist_url__v}}

Storing Sent Email Content

A Sent Email record can record up to 262,144 HTML characters worth of content of a sent Approved Email. The first 131,072 characters of content is stored in the email_content__v field of the Sent Email. If there are more than 131,072 characters, the remaining characters up to the maximum are stored in the email_content2__v field.

Stamping Sent Emails with Source Information

The following sent_email__v fields automatically stamp with contextual information to inform end users and content admins the circumstances around when the email was sent:

  • territory__v – References the sender's territory. If the sender belongs to multiple territories, this field references the first common territory between the user and the recipient.

  • email_source__v – References the field that was the source of the recipient’s email address.

    If an HCP is the recipient of an Approved Email, and the source of the email address used to send the HCP the email is the personemail__v field on the account, the email_source__v field on the resulting Sent Email is account__v.personemail__v.

  • email_config_values__v – Stamps consent information, if applicable, and indicates if a test email address was used. This field also shows headers, free text entered by the user, and any selected picklist values.

Sent Email Statuses

The status__v field on the sent_email__v object indicates the status of the sent email:

  • approved__v – Used to track review status
  • bounced__v – The email was successfully delivered to the recipient's email server, but was not delivered to the recipient's mailbox. This may happen if the mailbox could not be found by the server. Bounced emails are reattempted once by Vault CRM.
  • delivered__v – The email was successfully delivered to the recipient's email server
  • dropped__v – The email was not delivered to the recipient's server. This may be because the email address is in the Email Engine's suppression list. Any email sent to an email address with an existing bounced record automatically receives a status of Dropped.
  • failed__v – Vault CRM did not successfully send the email, either due to expired content or the presence of an opt-out record. The reason for failure is stamped on the status_details__v field
  • group__v – The email was sent from a group call. The associated business account does not receive the email, but is still tracked with this status.
  • marked_spam__v – The email was successfully delivered to the recipient's email server, but the server marked the email as spam
  • pending__v – Used to track review status
  • pending_approval__v – Used to track review status
  • rejected__v – Used to track review status
  • saved__v – The email was sent from Vault CRM and is awaiting confirmation from the server
  • scheduled__v – The email has been scheduled to be sent from Vault CRM
  • sent__v – The email engine successfully sent the email but has not yet received confirmation of delivery
  • unsubscribed__v – The email was delivered successfully and the recipient unsubscribed via the link in the email

Email Activity Event Types

The event_type__v picklist on the email_activity__v is automatically populated when the record is created and indicates the type of activity:

  • opened__v – The email was opened by the recipient. Mailgun tracks Opened events based on an image in the email rendering in the recipient's email client, usually a 1x1 pixel transparent image. If the recipient opens the email, the image downloads from the sending server, indicating the email was opened.

    Opened events are imprecise due to email clients behaving differently. There are scenarios where the email is opened, but an Opened event is not tracked, for example, if the email client rendered the email as plain-text, or if the email client cannot display images. To help improve the accuracy of tracking opened emails, Veeva automatically creates an Opened event if a Clicked event is logged and no Opened event already exists.

  • clicked__v – A link in the email was selected
  • unsubscribed__v – The recipient completed the unsubscribe process. Generates an opt-out multichannel_consent__v record.
  • unsubscribed_all__v – The email was delivered successfully and the recipient completed the global Approved Email unsubscribe process. Generates an opt-out multichannel_consent__v record and expires any previous opt-ins.
  • bounced__v – The delivery of the email failed.

    If the email bounced, the email address is added to the suppression list and any email sent to the address are automatically dropped. To remove an address from the suppression list, contact Veeva support. Once the address is removed from the suppression list, delete the associated multichannel_consent__v record.

  • marked_spam__v – The email was marked as spam by the recipient.
  • dropped__v – The delivery of the email failed. Generated automatically if there is a Bounced or Marked as Spam event.

The following additional event types are tracked by Vault when Vault documents in an Approved Email are viewed. These events are written into Vault CRM during the Vault-CRM scheduled integration:

  • viewed__v – A document included in the email was viewed in Vault PromoMats
  • downloaded__v – A document included in the email was downloaded from Vault PromoMats

Some email clients do not track when a recipient clicks a link in an email. When this occurs, the event types tracked by Vault do not have corresponding opened or clicked events.

Additionally, the event_msg__v field on the email_activity__v object contains information about the event, including any applicable SMTP Error Codes.

Tracking Email Activity at the Email Fragment Level

End users and content admins can track activity from a fragment included in an Approved Email to gain further insight into what kind of content is accessed most frequently. The approved_document__v field on the email_activity__v object references the fragment responsible for the email activity.

For the Vault link, there is no content change required. For non-Vault links, Content Administrators need to add the {{AppDocId}} token to the <a> tag in the Email Template or Fragment to indicate which URL needs tracking.

For example: Example - <a href = "https://www.veeva.com/?{{AppDocId}}"> Click Here. </a>.

If the AppDocId token is added to Vault links, the links are not accessible by users when previewing or editing the email.

End Users can leverage tracking of approved email activity in the following ways:

Due to supporting Universal Linking on the iOS HCP Engage app, click tracking is not supported for Approved Emails containing the following tokens:

  • {{call2__v.cobrowse_url_participant__v}}
  • {{em_attendee__v.webinar_participant_url__v}}
  • {{em_event_speaker__v.webinar_panelist_url__v}}

Storing Sent Email Content

A Sent Email record can record up to 262,144 HTML characters worth of content of a sent Approved Email. The first 131,072 characters of content is stored in the email_content__v field of the Sent Email. If there are more than 131,072 characters, the remaining characters up to the maximum are stored in the email_content2__v field.

Stamping Sent Emails with Source Information

The following sent_email__v fields automatically stamp with contextual information to inform end users and content admins the circumstances around when the email was sent:

  • territory__v – References the sender's territory. If the sender belongs to multiple territories, this field references the first common territory between the user and the recipient.

  • email_source__v – References the field that was the source of the recipient’s email address.

    If an HCP is the recipient of an Approved Email, and the source of the email address used to send the HCP the email is the personemail__v field on the account, the email_source__v field on the resulting Sent Email is account__v.personemail__v.

  • email_config_values__v – Stamps consent information, if applicable, and indicates if a test email address was used. This field also shows headers, free text entered by the user, and any selected picklist values.

Sent Email Statuses

The status__v field on the sent_email__v object indicates the status of the sent email:

  • approved__v – Used to track review status
  • bounced__v – The email was successfully delivered to the recipient's email server, but was not delivered to the recipient's mailbox. This may happen if the mailbox could not be found by the server. Bounced emails are reattempted once by Vault CRM.
  • delivered__v – The email was successfully delivered to the recipient's email server
  • dropped__v – The email was not delivered to the recipient's server. This may be because the email address is in the Email Engine's suppression list. Any email sent to an email address with an existing bounced record automatically receives a status of Dropped.
  • failed__v – Vault CRM did not successfully send the email, either due to expired content or the presence of an opt-out record. The reason for failure is stamped on the status_details__v field
  • group__v – The email was sent from a group call. The associated business account does not receive the email, but is still tracked with this status.
  • marked_spam__v – The email was successfully delivered to the recipient's email server, but the server marked the email as spam
  • pending__v – Used to track review status
  • pending_approval__v – Used to track review status
  • rejected__v – Used to track review status
  • saved__v – The email was sent from Vault CRM and is awaiting confirmation from the server
  • scheduled__v – The email has been scheduled to be sent from Vault CRM
  • sent__v – The email engine successfully sent the email but has not yet received confirmation of delivery
  • unsubscribed__v – The email was delivered successfully and the recipient unsubscribed via the link in the email

Email Activity Event Types

The event_type__v picklist on the email_activity__v is automatically populated when the record is created and indicates the type of activity:

  • opened__v – The email was opened by the recipient. Mailgun tracks Opened events based on an image in the email rendering in the recipient's email client, usually a 1x1 pixel transparent image. If the recipient opens the email, the image downloads from the sending server, indicating the email was opened.

    Opened events are imprecise due to email clients behaving differently. There are scenarios where the email is opened, but an Opened event is not tracked, for example, if the email client rendered the email as plain-text, or if the email client cannot display images. To help improve the accuracy of tracking opened emails, Veeva automatically creates an Opened event if a Clicked event is logged and no Opened event already exists.

  • clicked__v – A link in the email was selected
  • unsubscribed__v – The recipient completed the unsubscribe process. Generates an opt-out multichannel_consent__v record.
  • unsubscribed_all__v – The email was delivered successfully and the recipient completed the global Approved Email unsubscribe process. Generates an opt-out multichannel_consent__v record and expires any previous opt-ins.
  • bounced__v – The delivery of the email failed.

    If the email bounced, the email address is added to the suppression list and any email sent to the address are automatically dropped. To remove an address from the suppression list, contact Veeva support. Once the address is removed from the suppression list, delete the associated multichannel_consent__v record.

  • marked_spam__v – The email was marked as spam by the recipient.
  • dropped__v – The delivery of the email failed. Generated automatically if there is a Bounced or Marked as Spam event.

The following additional event types are tracked by Vault when Vault documents in an Approved Email are viewed. These events are written into Vault CRM during the Vault-CRM scheduled integration:

  • viewed__v – A document included in the email was viewed in Vault PromoMats
  • downloaded__v – A document included in the email was downloaded from Vault PromoMats

Some email clients do not track when a recipient clicks a link in an email. When this occurs, the event types tracked by Vault do not have corresponding opened or clicked events.

Additionally, the event_msg__v field on the email_activity__v object contains information about the event, including any applicable SMTP Error Codes.

Tracking Email Activity at the Email Fragment Level

End users and content admins can track activity from a fragment included in an Approved Email to gain further insight into what kind of content is accessed most frequently. The approved_document__v field on the email_activity__v object references the fragment responsible for the email activity.

For the Vault link, there is no content change required. For non-Vault links, Content Administrators need to add the {{AppDocId}} token to the <a> tag in the Email Template or Fragment to indicate which URL needs tracking.

For example: Example - <a href = "https://www.veeva.com/?{{AppDocId}}"> Click Here. </a>.

If the AppDocId token is added to Vault links, the links are not accessible by users when previewing or editing the email.

Related Topics

Approved Email Overview

Creating Approved Email Templates

Approved Email Configuration Tokens