ActionCdncStpMonthlyMetric

Represents the monthly engagement metrics for an action cadence step. This object is available in API version 49.0 and later.

Supported Calls

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

Special Access Rules

Sales Engagement must be enabled.

Fields

Field Details
ActionCadenceStepId
Type
reference
Properties
Filter, Group, Sort
Description
The ID of the related action cadence step.
This is a relationship field.
Relationship Name
ActionCadenceStep
Relationship Type
This is an overview-detail relationship field, where ActionCadenceStep is the master object.
Refers To
ActionCadenceStep
AllCallsCallBackLater
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of calls in the month for this step 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 step with the call result Left Voicemail.
AllCallsMeaningfulConnect
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of calls in the month for this step with the call result Meaningful Connect.
AllCallsNotInterested
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of calls in the month for this step with the call result Not Interested.
AllCallsUncategorized
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of calls in the month for this step with no call result specified.
AllCallsUnqualified
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of calls in the month for this step with the call result Unqualified.
AllEmailsBouncedCount
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The total of hard and soft bounced emails for this step in the month.
This is a calculated field.
AllEmailsDeliveredCount
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of successfully delivered emails for this step in the month.
This is a calculated field.
AllEmailsHardBouncedCount
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of hard bounced emails for this step in the month.
AllEmailsLinkClickedCount
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of emails containing a link clicked by the recipient for this step in the month.
AllEmailsNotDeliveredCount
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of sent emails that were bounced for all recipients on the email. Bounced emails aren’t marked as delivered. 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 for this step in the month.
AllEmailsOutOfOfficeCount
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of emails that triggered an out-of-office reply for this step in the month.
AllEmailsRepliedCount
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of emails replied to for this step in the month.
AllEmailsSentCount
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of emails sent for this step in the month.
This is a calculated field.
AllEmailsSoftBouncedCount
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of emails soft bounced for this step in the month.
AllEmailsTrackedSentCount
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of emails sent with engagement tracking enabled for this step in the month. Available in API version 51.0 and later.
AllEmailsUntrackedSentCount
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of emails sent without engagement tracking for this step in the month. Available in API version 51.0 and later.
AllTotalCallsCount
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The total number of calls with all call results for this step in the month.
This is a calculated field.
DeliveredRecipientCount
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of recipients that were successfully delivered an email. Available in API version 54.0 and later.
This field is a calculated field.
DeliveredRecipientRate
Type
percent
Properties
Filter, Nillable, Sort
Description
The percentage of unique recipients that received an email you sent. Available in API version 54.0 and later.
This field 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 54.0 and later.
HasTemplateAssigned
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Indicates whether this step has an associated email template or call script. Available in API version 52.0 and later.
The default value is 'false'.
HrdBncTrackableRecipientSends
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of recipients who received an email with hard bounce tracking. Available in API version 54.0 and later.
IsCompoundMetric
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
When true, indicates that this metric represents engagement for a combination of the action cadence step and a single email template. The value is true for all action cadence steps created in Summer ’21 and later.
When false, indicates that the metric represents engagement for the action cadence step and all email templates used on the step. The value is false for all action cadence steps created in Spring ’21 and earlier. The default value is 'false'.
Available in API version 52.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 54.0 and later.
LinkClkTrackableRecipientSends
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of recipients who received an email with link tracking. Available in API version 54.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 received an email with out-of-office tracking. Out-of-office tracking requires Inbox. Available in API version 54.0 and later.
OpenTrackableRecipientSends
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of recipients who received an email with open tracking. Available in API version 54.0 and later.
OpenTrackableSends
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of emails sent with open tracking. Available in API version 54.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 54.0 and later.
RecipientReplies
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of unique recipients who replied to an email. Available in API version 54.0 and later.
RecipientSends
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of unique email recipients. Available in API version 54.0 and later.
RecipientsHardBounced
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of recipients that hard-bounced an email. Hard bounces can mean that the recipient's email address doesn't exist or is misspelled. Available in API version 54.0 and later.
RecipientsOutOfOffice
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of recipients that responded with an out-of-office reply. Available in API version 54.0 and later.
RecipientsSoftBounced
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of recipients that soft-bounced an email. A soft bounce often indicates a temporary issue with the recipient's email server, such as a full inbox. Available in API version 54.0 and later.
ReplyTrackableRecipientSends
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of recipients who received an email with reply tracking. Available in API version 54.0 and later.
ReplyTrackableSends
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of emails sent with reply tracking. Available in API version 54.0 and later.
SftBncTrackableRecipientSends
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of recipients who received 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 54.0 and later.
SomeEmailsDeliveredCount
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of sent emails that were successfully delivered to at least one of its recipients. 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 sent and tracked emails that were successfully delivered to at least one of their recipients. Available in API version 54.0 and later.
This field is a calculated field.
TemplateId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
The ID of the email template or call script associated with this step. Available in API version 52.0 and later.
This is a polymorphic relationship field.
Relationship Name
Template
Relationship Type
Lookup
Refers To
CallTemplate, EmailTemplate
TrackableRecipientSendHrdBncRt
Type
percent
Properties
Filter, Nillable, Sort
Description
The percentage of emails sent to unique recipients with hard bounce tracking that hard bounced. 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 received out-of-office replies from unique recipients. 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. Available in API version 54.0 and later.
This field is a calculated field.
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 54.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 the recipient. Available in API version 54.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 54.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 for this step in the month.
UniqueEmailsOpenedCount
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of unique recipients who opened an email for this step in the month.
UniqueEmailsRepliedCount
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of unique recipients who replied to an email for this step in the month.