UserMonthlyMetric

Represents the monthly engagement metrics for a user. This object is available in API version 52.0 and later.

Supported Calls

describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()

Special Access Rules

Sales Engagement must be enabled.

Fields

Field Details
AllCallsCallBackLater
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of calls in the month for this user with the call result Call Back Later.
AllCallsLeftVoicemail
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of calls in the month for this user with the call result Left Voicemail.
AllCallsMeaningfulConnect
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of calls in the month for this user with the call result Meaningful Connect.
AllCallsNotInterested
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of calls in the month for this user with the call result Not Interested.
AllCallsUncategorized
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of calls in the month for this user with no call result specified.
AllCallsUnqualified
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of calls in the month for this user with the call result Unqualified.
AllEmailsBouncedCount
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The total of hard and soft bounced emails sent by this user in the month.
This is a calculated field.
AllEmailsDeliveredCount
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of successfully delivered emails sent by this user in the month.
This is a calculated field.
AllEmailsHardBouncedCount
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of hard bounced emails sent by this user in the month.
AllEmailsLinkClickedCount
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of emails containing a link clicked by the recipient sent by this user in the month.
AllEmailsNotDeliveredCount
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of emails that were undelivered for all recipients on the email. Available in API version 54.0 and later.
AllEmailsOpenedCount
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of emails opened by the recipient sent by this user in the month.
AllEmailsOutOfOfficeCount
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of emails that triggered an out-of-office reply sent by this user in the month.
AllEmailsRepliedCount
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of emails replied to for this user in the month.
AllEmailsSentCount
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of emails sent by this user in the month.
This is a calculated field.
AllEmailsSoftBouncedCount
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of emails sent by this user that soft bounced in the month.
AllEmailsTrackedSentCount
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of emails sent by this user with engagement tracking enabled in the month.
AllEmailsUntrackedSentCount
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of emails sent by this user without engagement tracking enabled in the month.
AllTotalCallsCount
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The total number of calls with all call results for this user in the month.
This is a calculated field.
DeliveredRecipientCount
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of recipients who successfully received an email. Available in API version 53.0 and later.
This is a calculated field.
DeliveredRecipientRate
Type
percent
Properties
Filter, Nillable, Sort
Description
The percentage of unique recipients who successfully received an email. Available in API version 53.0 and later.
This is a calculated field.
HardBounceTrackableSends
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of emails sent with hard bounce tracking. Available in API version 53.0 and later.
HrdBncTrackableRecipientSends
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of recipients who were sent an email with hard bounce tracking. Available in API version 53.0 and later.
LinkClickTrackableSends
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of emails sent with link click tracking. Available in API version 53.0 and later.
LinkClkTrackableRecipientSends
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of recipients who were sent an email with link click tracking. Available in API version 53.0 and later.
Month
Type
date
Properties
Filter, Group, Sort
Description
The month in which the engagement occurred.
MonthInt
Type
int
Properties
Filter, Group, idLookup, Sort
Description
The month in which the engagement occurred, in yyyymm format.
OooTrackableRecipientSends
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of recipients who were sent an email with out-of-office tracking. Available in API version 53.0 and later.
OpenTrackableRecipientSends
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of recipients who were sent an email with open tracking. Available in API version 53.0 and later.
OpenTrackableSends
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of emails sent with open tracking. Available in API version 53.0 and later.
OutOfOfficeTrackableSends
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of emails sent with out-of-office tracking. Available in API version 53.0 and later.
RecipientReplies
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of unique recipients who responded to an email. Available in API version 53.0 and later.
RecipientSends
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of unique recipients who were sent an email. Available in API version 53.0 and later.
RecipientsHardBounced
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of email recipients who were sent an email that hard bounced. Available in API version 54.0 and later.
RecipientsOutOfOffice
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of recipients who responded with an out-of-office reply. Available in API version 54.0 and later.
RecipientsSoftBounce
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of recipients who were sent an email that soft bounced. Available in API version 54.0 and later.
ReplyTrackableRecipientSends
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of recipients who were sent an email with reply tracking. Available in API version 53.0 and later.
ReplyTrackableSends
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of emails sent with reply tracking. Available in API version 53.0 and later.
SftBncTrackableRecipientSends
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of recipients who were sent an email with soft bounce tracking. Available in API version 53.0 and later.
SoftBounceTrackableSends
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of emails sent with soft bounce tracking. Available in API version 53.0 and later.
SomeEmailsDeliveredCount
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of emails that were successfully delivered to at least one recipient on the email. Available in API version 54.0 and later.
This field is a calculated field.
SomeEmailsDeliveredRate
Type
percent
Properties
Filter, Nillable, Sort
Description
The percentage of emails that were successfully delivered to at least one recipient on the email. Available in API version 54.0 and later.
This field is a calculated field.
TrackableRecipientSendHrdBncRt
Type
percent
Properties
Filter, Nillable, Sort
Description
The percentage of unique recipients who hard bounced an email with hard bounce tracking. Available in API version 54.0 and later.
This field is a calculated field.
TrackableRecipientSendOooRate
Type
percent
Properties
Filter, Nillable, Sort
Description
The percentage of emails sent with out-of-office tracking that resulted in out-of-office replies from unique recipients. This field is a calculated field. Available in API version 54.0 and later.
This field is a calculated field.
TrackableRecipientSendReplyRt
Type
percent
Properties
Filter, Nillable, Sort
Description
The percentage of emails sent with reply tracking that received replies from unique recipients. Available in API version 54.0 and later.
This field is a calculated field.
TrackableRecipientSendSftBncRt
Type
percent
Properties
Filter, Nillable, Sort
Description
The percentage of emails sent to unique recipients with soft bounce tracking that soft bounced.
This field is a calculated field. Available in API version 54.0 and later.
TrackableSendHardBounceRate
Type
percent
Properties
Filter, Nillable, Sort
Description
The percentage of emails sent with hard bounce tracking that hard bounced. Available in API version 54.0 and later.
This field is a calculated field.
TrackableSendLinkClickRate
Type
percent
Properties
Filter, Nillable, Sort
Description
The percentage of emails sent with link tracking that had link clicks. Available in API version 53.0 and later.
This field is a calculated field.
TrackableSendOpenRate
Type
percent
Properties
Filter, Nillable, Sort
Description
The percentage of emails sent with open tracking that were opened by a recipient. Available in API version 53.0 and later.
This field is a calculated field.
TrackableSendOutOfOfficeRate
Type
percent
Properties
Filter, Nillable, Sort
Description
The percentage of emails sent with out-of-office tracking that received out-of-office replies. Available in API version 54.0 and later.
This field is a calculated field.
TrackableSendReplyRate
Type
percent
Properties
Filter, Nillable, Sort
Description
The percentage of emails sent with reply tracking that received replies. Available in API version 53.0 and later.
This field is a calculated field.
TrackableSendSoftBounceRate
Type
percent
Properties
Filter, Nillable, Sort
Description
The percentage of emails sent with soft bounce tracking that soft bounced. Available in API version 54.0 and later.
This field is a calculated field.
UniqueEmailsLinkClickedCount
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of unique recipients who clicked a link in an email sent by this user in the month.
UniqueEmailsOpenedCount
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of unique recipients who opened an email sent by this user in the month.
UniqueEmailsRepliedCount
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of unique recipients who replied to an email sent by this user in the month.
UserId
Type
reference
Properties
Filter, Group, Sort
Description
The ID of the related user.
This is a relationship field.
Relationship Name
User
Relationship Type
Lookup
Refers To
User

Associated Objects

This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.

UserMonthlyMetricOwnerSharingRule
Sharing rules are available for the object.
UserMonthlyMetricShare
Sharing is available for the object.