Newer Version Available

This content describes an older version of this product. View Latest

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

High Velocity Sales 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.
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.
IsLocked
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Indicates whether the monthly metric record is locked or not.
The default value is false.
MayEdit
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Indicates whether the monthly metric record can be edited or not.
The default value is false.
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.
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.