kris/afv-library
1
0
Fork 0
mirror of https://github.com/forcedotcom/afv-library.git synced 2026-08-06 15:59:59 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity
4bc39ed386
afv-library/skills/platform-data-and-tooling-api-context-get/assets/enterprise_api/ActionCdncStpMonthlyMetric.json

668 lines
24 KiB
JSON
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

{
"sections": [
"title",
"description",
"fields",
"special_access_rules",
"field_reference"
],
"title": "ActionCdncStpMonthlyMetric - Data API",
"description": "Represents the monthly engagement metrics for an action cadence step. This object is available in API version 49.0 and later.",
"fields_columns": [
"type",
"properties",
"description",
"relationship_name",
"relationship_type",
"refers_to"
],
"fields": {
"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": "Master-detail",
"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."
}
},
"special_access_rules": "Sales Engagement must be enabled.",
"field_reference": {
"ActionCadenceStepId": {
"field_label": "Action Cadence Step ID",
"type": "reference",
"length": "18"
},
"AllCallsCallBackLater": {
"field_label": "All Calls Call Back Later Count",
"type": "int",
"digits": "9"
},
"AllCallsLeftVoicemail": {
"field_label": "All Calls Left Voicemail Count",
"type": "int",
"digits": "9"
},
"AllCallsMeaningfulConnect": {
"field_label": "All Calls Meaningful Connect Count",
"type": "int",
"digits": "9"
},
"AllCallsNotInterested": {
"field_label": "All Calls Not Interested Count",
"type": "int",
"digits": "9"
},
"AllCallsUncategorized": {
"field_label": "All Calls Uncategorized Count",
"type": "int",
"digits": "9"
},
"AllCallsUnqualified": {
"field_label": "All Calls Unqualified Count",
"type": "int",
"digits": "9"
},
"AllEmailsBouncedCount": {
"field_label": "All Emails Bounced Count",
"type": "int",
"digits": "9"
},
"AllEmailsDeliveredCount": {
"field_label": "All Emails Delivered Count",
"type": "int",
"digits": "9"
},
"AllEmailsHardBouncedCount": {
"field_label": "All Emails Hard Bounced Count",
"type": "int",
"digits": "9"
},
"AllEmailsLinkClickedCount": {
"field_label": "All Emails Link Clicked Count",
"type": "int",
"digits": "9"
},
"AllEmailsNotDeliveredCount": {
"field_label": "All Emails Not Delivered Count",
"type": "int",
"digits": "9"
},
"AllEmailsOpenedCount": {
"field_label": "All Emails Opened Count",
"type": "int",
"digits": "9"
},
"AllEmailsOutOfOfficeCount": {
"field_label": "All Emails Out of Office Count",
"type": "int",
"digits": "9"
},
"AllEmailsRepliedCount": {
"field_label": "All Emails Replied Count",
"type": "int",
"digits": "9"
},
"AllEmailsSentCount": {
"field_label": "All Emails Sent Count",
"type": "int",
"digits": "9"
},
"AllEmailsSoftBouncedCount": {
"field_label": "All Emails Soft Bounced Count",
"type": "int",
"digits": "9"
},
"AllEmailsTrackedSentCount": {
"field_label": "All Emails Tracked Sent Count",
"type": "int",
"digits": "9"
},
"AllEmailsUntrackedSentCount": {
"field_label": "All Emails Untracked Sent Count",
"type": "int",
"digits": "9"
},
"AllTotalCallsCount": {
"field_label": "All Calls per Month",
"type": "int",
"digits": "9"
},
"CreatedById": {
"field_label": "Created By ID",
"type": "reference",
"length": "18"
},
"CreatedDate": {
"field_label": "Created Date",
"type": "datetime"
},
"DeliveredRecipientCount": {
"field_label": "Delivered Recipient Count",
"type": "int",
"digits": "9"
},
"DeliveredRecipientRate": {
"field_label": "Delivered Recipient Rate",
"type": "percent",
"precision": "5",
"scale": "2"
},
"HardBounceTrackableSends": {
"field_label": "Hard Bounce Trackable Sends",
"type": "int",
"digits": "9"
},
"HasTemplateAssigned": {
"field_label": "Template Assigned",
"type": "boolean"
},
"HrdBncTrackableRecipientSends": {
"field_label": "Hard Bounce Trackable Recipient Sends",
"type": "int",
"digits": "9"
},
"Id": {
"field_label": "Cadence Step Monthly Metric ID",
"type": "id",
"length": "18"
},
"IsCompoundMetric": {
"field_label": "Is Compound Metric",
"type": "boolean"
},
"IsDeleted": {
"field_label": "Deleted",
"type": "boolean"
},
"LastModifiedById": {
"field_label": "Last Modified By ID",
"type": "reference",
"length": "18"
},
"LastModifiedDate": {
"field_label": "Last Modified Date",
"type": "datetime"
},
"LinkClickTrackableSends": {
"field_label": "Link Click Trackable Sends",
"type": "int",
"digits": "9"
},
"LinkClkTrackableRecipientSends": {
"field_label": "Link Click Trackable Recipient Sends",
"type": "int",
"digits": "9"
},
"Month": {
"field_label": "Month",
"type": "date"
},
"MonthInt": {
"field_label": "Month Int",
"type": "int",
"digits": "9"
},
"OooTrackableRecipientSends": {
"field_label": "Out Of Office Trackable Recipient Sends",
"type": "int",
"digits": "9"
},
"OpenTrackableRecipientSends": {
"field_label": "Open Trackable Recipient Sends",
"type": "int",
"digits": "9"
},
"OpenTrackableSends": {
"field_label": "Open Trackable Sends",
"type": "int",
"digits": "9"
},
"OutOfOfficeTrackableSends": {
"field_label": "Out Of Office Trackable Sends",
"type": "int",
"digits": "9"
},
"RecipientReplies": {
"field_label": "Recipient Replies",
"type": "int",
"digits": "9"
},
"RecipientSends": {
"field_label": "Recipient Sends",
"type": "int",
"digits": "9"
},
"RecipientsHardBounced": {
"field_label": "Recipients Hard Bounced",
"type": "int",
"digits": "9"
},
"RecipientsOutOfOffice": {
"field_label": "Recipients Out Of Office",
"type": "int",
"digits": "9"
},
"RecipientsSoftBounced": {
"field_label": "Recipients Soft Bounced",
"type": "int",
"digits": "9"
},
"ReplyTrackableRecipientSends": {
"field_label": "Reply Trackable Recipient Sends",
"type": "int",
"digits": "9"
},
"ReplyTrackableSends": {
"field_label": "Reply Trackable Sends",
"type": "int",
"digits": "9"
},
"SftBncTrackableRecipientSends": {
"field_label": "Soft Bounce Trackable Recipient Sends",
"type": "int",
"digits": "9"
},
"SoftBounceTrackableSends": {
"field_label": "Soft Bounce Trackable Sends",
"type": "int",
"digits": "9"
},
"SomeEmailsDeliveredCount": {
"field_label": "Some Emails Delivered Count",
"type": "int",
"digits": "9"
},
"SomeEmailsDeliveredRate": {
"field_label": "Some Emails Delivered Rate",
"type": "percent",
"precision": "5",
"scale": "2"
},
"SystemModstamp": {
"field_label": "System Modstamp",
"type": "datetime"
},
"TemplateId": {
"field_label": "Template ID",
"type": "reference",
"length": "18"
},
"TrackableRecipientSendHrdBncRt": {
"field_label": "Trackable Recipient Send Hard Bounce Rate",
"type": "percent",
"precision": "5",
"scale": "2"
},
"TrackableRecipientSendOooRate": {
"field_label": "Trackable Recipient Send Out of Office Rate",
"type": "percent",
"precision": "5",
"scale": "2"
},
"TrackableRecipientSendReplyRt": {
"field_label": "Trackable Recipient Send Reply Rate",
"type": "percent",
"precision": "5",
"scale": "2"
},
"TrackableRecipientSendSftBncRt": {
"field_label": "Trackable Recipient Send Soft Bounce Rate",
"type": "percent",
"precision": "5",
"scale": "2"
},
"TrackableSendHardBounceRate": {
"field_label": "Trackable Send Hard Bounce Rate",
"type": "percent",
"precision": "5",
"scale": "2"
},
"TrackableSendLinkClickRate": {
"field_label": "Trackable Send Link Click Rate",
"type": "percent",
"precision": "5",
"scale": "2"
},
"TrackableSendOpenRate": {
"field_label": "Trackable Send Open Rate",
"type": "percent",
"precision": "5",
"scale": "2"
},
"TrackableSendOutOfOfficeRate": {
"field_label": "Trackable Send Out Of Office Rate",
"type": "percent",
"precision": "5",
"scale": "2"
},
"TrackableSendReplyRate": {
"field_label": "Trackable Send Reply Rate",
"type": "percent",
"precision": "5",
"scale": "2"
},
"TrackableSendSoftBounceRate": {
"field_label": "Trackable Send Soft Bounce Rate",
"type": "percent",
"precision": "5",
"scale": "2"
},
"UniqueEmailsLinkClickedCount": {
"field_label": "Unique Emails Link Clicked per Month",
"type": "int",
"digits": "9"
},
"UniqueEmailsOpenedCount": {
"field_label": "Unique Emails Opened per Month",
"type": "int",
"digits": "9"
},
"UniqueEmailsRepliedCount": {
"field_label": "Unique Emails Replied per Month",
"type": "int",
"digits": "9"
}
},
"field_reference_columns": [
"field_label",
"type",
"length",
"digits",
"precision",
"scale"
]
}
Reference in New Issue View Git Blame Copy Permalink