afv-library/skills/platform-data-and-tooling-api-context-get/assets/enterprise_api/LeadDailyMetric.json

{
  "sections": [
    "title",
    "description",
    "fields",
    "special_access_rules",
    "field_reference"
  ],
  "title": "LeadDailyMetric - Data API",
  "description": "Represents the daily engagement metrics for a lead. 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 day for this lead with the call result Call Back Later."
    },
    "AllCallsLeftVoicemail": {
      "type": "int",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The number of calls in the day for this lead with the call result Left Voicemail."
    },
    "AllCallsMeaningfulConnect": {
      "type": "int",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The number of calls in the day for this lead with the call result Meaningful Connect."
    },
    "AllCallsNotInterested": {
      "type": "int",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The number of calls in the day for this lead with the call result Not Interested."
    },
    "AllCallsUncategorized": {
      "type": "int",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The number of calls in the day for this lead with no call result specified."
    },
    "AllCallsUnqualified": {
      "type": "int",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The number of calls in the day for this lead with the call result Unqualified."
    },
    "AllEmailsBouncedCount": {
      "type": "int",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The total of hard and soft bounced emails for this lead in the day. This is a calculated field."
    },
    "AllEmailsDeliveredCount": {
      "type": "int",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The number of successfully delivered emails for this lead in the day. 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 lead. This field is a calculated field. Available in API version 54.0 and later."
    },
    "AllEmailsHardBouncedCount": {
      "type": "int",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The number of hard bounced emails for this lead in the day."
    },
    "AllEmailsOutOfOfficeCount": {
      "type": "int",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The number of emails that triggered an out of office reply for this lead in the day."
    },
    "AllEmailsSentCount": {
      "type": "int",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The number of emails sent to this lead in the day. This is a calculated field."
    },
    "AllEmailsSoftBouncedCount": {
      "type": "int",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The number of emails soft bounced for this lead in the day."
    },
    "AllEmailsTrackedSentCount": {
      "type": "int",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The number of emails sent to this lead with engagement tracking enabled in the day."
    },
    "AllEmailsUntrackedSentCount": {
      "type": "int",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The number of emails sent to this lead without engagement tracking enabled in the day."
    },
    "AllTotalCallsCount": {
      "type": "int",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The total number of calls to this lead with all call results in the day. This is a calculated field."
    },
    "DailyCutOffTimeStamp": {
      "type": "dateTime",
      "properties": "Filter, Sort",
      "description": "The time of day when each 24-hour metrics period starts and ends."
    },
    "Date": {
      "type": "date",
      "properties": "Filter, Group, Sort",
      "description": "The date on which the engagement occurred."
    },
    "DateInt": {
      "type": "int",
      "properties": "Filter, Group, idLookup, Sort",
      "description": "The date on which the engagement occurred, in yyyymmdd format."
    },
    "HardBounceTrackableSends": {
      "type": "int",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The number of emails sent to this lead with hard bounce tracking. Available in API version 54.0 and later."
    },
    "InboundEngagementsCount": {
      "type": "int",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The number of inbound engagements for this lead in the day. This field is a calculated field. The value is the sum of UniqueEmailsOpenedCount, UniqueEmailsRepliedCount, and UniqueEmailsLinkClickedCount. Available in API version 58.0 and later."
    },
    "LeadId": {
      "type": "reference",
      "properties": "Filter, Group, Sort",
      "description": "The ID of the related lead. This is a relationship field.",
      "relationship_name": "Lead",
      "relationship_type": "Lookup",
      "refers_to": "Lead"
    },
    "LinkClickTrackableSends": {
      "type": "int",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The number of emails sent to this lead with link click tracking. Available in API version 54.0 and later."
    },
    "OpenTrackableSends": {
      "type": "int",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The number of emails sent to this lead 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 lead with out-of-office tracking. Available in API version 54.0 and later."
    },
    "OutboundEngagementsCount": {
      "type": "int",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The number of outbound engagements for this lead in the day. This field is a calculated field. The value is the sum of AllTotalCallsCount and AllEmailsDeliveredCount. Available in API version 58.0 and later."
    },
    "ReplyTrackableSends": {
      "type": "int",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The number of emails sent to this lead 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 lead 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 lead with hard bounce tracking that hard bounced. This field is a calculated field. Available in API version 54.0 and later."
    },
    "TrackableSendLinkClickRate": {
      "type": "percent",
      "properties": "Filter, Nillable, Sort",
      "description": "The percentage of emails sent to this lead with link tracking that had link clicks. This field is a calculated field. Available in API version 54.0 and later."
    },
    "TrackableSendOpenRate": {
      "type": "percent",
      "properties": "Filter, Nillable, Sort",
      "description": "The percentage of emails sent to this lead with open tracking that were opened by the recipient. This field is a calculated field. Available in API version 54.0 and later."
    },
    "TrackableSendOutOfOfficeRate": {
      "type": "percent",
      "properties": "Filter, Nillable, Sort",
      "description": "The percentage of emails sent to this lead with out-of-office tracking that received out-of-office replies. This field is a calculated field. Available in API version 54.0 and later."
    },
    "TrackableSendReplyRate": {
      "type": "percent",
      "properties": "Filter, Nillable, Sort",
      "description": "The percentage of emails sent to this lead with reply tracking that received replies. This field is a calculated field. Available in API version 54.0 and later."
    },
    "TrackableSendSoftBounceRate": {
      "type": "percent",
      "properties": "Filter, Nillable, Sort",
      "description": "The percentage of emails sent to this lead with soft bounce tracking that soft bounced. This field is a calculated field. Available in API version 54.0 and later."
    },
    "UniqueEmailsLinkClickedCount": {
      "type": "int",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The number of individual emails in which the lead clicked a link in the day."
    },
    "UniqueEmailsOpenedCount": {
      "type": "int",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The number of individual emails opened by the lead in the day."
    },
    "UniqueEmailsRepliedCount": {
      "type": "int",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The number of individual emails replied to by the lead in the day."
    }
  },
  "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"
    },
    "CreatedById": {
      "field_label": "Created By ID",
      "type": "reference",
      "length": "18"
    },
    "CreatedDate": {
      "field_label": "Created Date",
      "type": "datetime"
    },
    "DailyCutOffTimeStamp": {
      "field_label": "Daily Cutoff Time",
      "type": "datetime"
    },
    "Date": {
      "field_label": "Date",
      "type": "date"
    },
    "DateInt": {
      "field_label": "Date Int",
      "type": "int",
      "digits": "9"
    },
    "HardBounceTrackableSends": {
      "field_label": "Hard Bounce Trackable Sends",
      "type": "int",
      "digits": "9"
    },
    "Id": {
      "field_label": "Lead Daily Metric ID",
      "type": "id",
      "length": "18"
    },
    "InboundEngagementsCount": {
      "field_label": "Inbound Engagements Count",
      "type": "int",
      "digits": "9"
    },
    "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"
    },
    "LeadId": {
      "field_label": "Lead ID",
      "type": "reference",
      "length": "18"
    },
    "LinkClickTrackableSends": {
      "field_label": "Link Click Trackable 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"
    },
    "OutboundEngagementsCount": {
      "field_label": "Outbound Engagements Count",
      "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"
  ]
}