{ "sections": [ "title", "description", "fields", "special_access_rules", "field_reference" ], "title": "ContactMonthlyMetric - Data API", "description": "Represents the monthly engagement metrics for a contact. This object is available in API version 52.0 and later.", "fields_columns": [ "type", "properties", "description", "relationship_name", "relationship_type", "refers_to" ], "fields": { "AllCallsCallBackLater": { "type": "int", "properties": "Filter, Group, Nillable, Sort", "description": "The number of calls in the month for this contact 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 contact with the call result Left Voicemail." }, "AllCallsMeaningfulConnect": { "type": "int", "properties": "Filter, Group, Nillable, Sort", "description": "The number of calls in the month for this contact with the call result Meaningful Connect." }, "AllCallsNotInterested": { "type": "int", "properties": "Filter, Group, Nillable, Sort", "description": "The number of calls in the month for this contact with the call result Not Interested." }, "AllCallsUncategorized": { "type": "int", "properties": "Filter, Group, Nillable, Sort", "description": "The number of calls in the month for this contact with no call result specified." }, "AllCallsUnqualified": { "type": "int", "properties": "Filter, Group, Nillable, Sort", "description": "The number of calls in the month for this contact with the call result Unqualified." }, "AllEmailsBouncedCount": { "type": "int", "properties": "Filter, Group, Nillable, Sort", "description": "The total of hard and soft bounced emails for this contact 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 contact in the month. This is a calculated field." }, "AllEmailsDeliveredRate": { "type": "percent", "properties": "Filter, Nillable, Sort", "description": "The percentage of tracked emails sent that were successfully delivered to this contact. Available in API version 54.0 and later. This field is a calculated field." }, "AllEmailsHardBouncedCount": { "type": "int", "properties": "Filter, Group, Nillable, Sort", "description": "The number of hard bounced emails for this contact 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 contact in the month." }, "AllEmailsSentCount": { "type": "int", "properties": "Filter, Group, Nillable, Sort", "description": "The number of emails sent to this contact 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 contact in the month." }, "AllEmailsTrackedSentCount": { "type": "int", "properties": "Filter, Group, Nillable, Sort", "description": "The number of emails sent to this contact with engagement tracking enabled in the month." }, "AllEmailsUntrackedSentCount": { "type": "int", "properties": "Filter, Group, Nillable, Sort", "description": "The number of emails sent to this contact without engagement tracking enabled in the month." }, "AllTotalCallsCount": { "type": "int", "properties": "Filter, Group, Nillable, Sort", "description": "The total number of calls to this contact with all call results in the month. This is a calculated field." }, "ContactId": { "type": "reference", "properties": "Filter, Group, Sort", "description": "The ID of the related contact. This is a relationship field.", "relationship_name": "Contact", "relationship_type": "Lookup", "refers_to": "Contact" }, "HardBounceTrackableSends": { "type": "int", "properties": "Filter, Group, Nillable, Sort", "description": "The number of emails sent to this contact with hard bounce tracking. Available in API version 54.0 and later." }, "LinkClickTrackableSends": { "type": "int", "properties": "Filter, Group, Nillable, Sort", "description": "The number of emails sent to this contact with link click 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." }, "OpenTrackableSends": { "type": "int", "properties": "Filter, Group, Nillable, Sort", "description": "The number of emails sent to this contact 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 to this contact with out-of-office tracking. Available in API version 54.0 and later." }, "ReplyTrackableSends": { "type": "int", "properties": "Filter, Group, Nillable, Sort", "description": "The number of emails sent to this contact with reply tracking. Available in API version 54.0 and later." }, "SoftBounceTrackableSends": { "type": "int", "properties": "Filter, Group, Nillable, Sort", "description": "The number of emails sent to this contact with soft bounce tracking. Available in API version 54.0 and later." }, "TrackableSendHardBounceRate": { "type": "percent", "properties": "Filter, Nillable, Sort", "description": "The percentage of emails sent to this contact 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 to this contact 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 to this contact 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 to this contact 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 to this contact 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 to this contact 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 individual emails in which the contact clicked a link in the month." }, "UniqueEmailsOpenedCount": { "type": "int", "properties": "Filter, Group, Nillable, Sort", "description": "The number of individual emails opened by the contact in the month." }, "UniqueEmailsRepliedCount": { "type": "int", "properties": "Filter, Group, Nillable, Sort", "description": "The number of individual emails replied to by the contact in the month." } }, "special_access_rules": "Inbox must be enabled.", "field_reference": { "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" }, "AllEmailsDeliveredRate": { "field_label": "All Emails Delivered Rate", "type": "percent", "precision": "5", "scale": "2" }, "AllEmailsHardBouncedCount": { "field_label": "All Emails Hard Bounced Count", "type": "int", "digits": "9" }, "AllEmailsOutOfOfficeCount": { "field_label": "All Emails Out of Office 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 Total Calls Count", "type": "int", "digits": "9" }, "ContactId": { "field_label": "Contact ID", "type": "reference", "length": "18" }, "CreatedById": { "field_label": "Created By ID", "type": "reference", "length": "18" }, "CreatedDate": { "field_label": "Created Date", "type": "datetime" }, "HardBounceTrackableSends": { "field_label": "Hard Bounce Trackable Sends", "type": "int", "digits": "9" }, "Id": { "field_label": "Contact Monthly Metric ID", "type": "id", "length": "18" }, "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" }, "Month": { "field_label": "Month", "type": "date" }, "MonthInt": { "field_label": "Month Int", "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" }, "ReplyTrackableSends": { "field_label": "Reply Trackable Sends", "type": "int", "digits": "9" }, "SoftBounceTrackableSends": { "field_label": "Soft Bounce Trackable Sends", "type": "int", "digits": "9" }, "SystemModstamp": { "field_label": "System Modstamp", "type": "datetime" }, "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 Count", "type": "int", "digits": "9" }, "UniqueEmailsOpenedCount": { "field_label": "Unique Emails Opened Count", "type": "int", "digits": "9" }, "UniqueEmailsRepliedCount": { "field_label": "Unique Emails Replied Count", "type": "int", "digits": "9" } }, "field_reference_columns": [ "field_label", "type", "digits", "precision", "scale", "length" ] }