mirror of
https://github.com/forcedotcom/afv-library.git
synced 2026-08-06 15:59:59 +08:00
489 lines
17 KiB
JSON
489 lines
17 KiB
JSON
{
|
||
"sections": [
|
||
"title",
|
||
"description",
|
||
"fields",
|
||
"special_access_rules",
|
||
"associated_objects",
|
||
"field_reference"
|
||
],
|
||
"title": "UserDailyMetric - Data API",
|
||
"description": "Represents the daily engagement metrics for a user. 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 user 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 user with the call result Left Voicemail."
|
||
},
|
||
"AllCallsMeaningfulConnect": {
|
||
"type": "int",
|
||
"properties": "Filter, Group, Nillable, Sort",
|
||
"description": "The number of calls in the day for this user with the call result Meaningful Connect."
|
||
},
|
||
"AllCallsNotInterested": {
|
||
"type": "int",
|
||
"properties": "Filter, Group, Nillable, Sort",
|
||
"description": "The number of calls in the day for this user with the call result Not Interested."
|
||
},
|
||
"AllCallsUncategorized": {
|
||
"type": "int",
|
||
"properties": "Filter, Group, Nillable, Sort",
|
||
"description": "The number of calls in the day for this user with no call result specified."
|
||
},
|
||
"AllCallsUnqualified": {
|
||
"type": "int",
|
||
"properties": "Filter, Group, Nillable, Sort",
|
||
"description": "The number of calls in the day 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 for this user 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 user in the day. This is a calculated field."
|
||
},
|
||
"AllEmailsHardBouncedCount": {
|
||
"type": "int",
|
||
"properties": "Filter, Group, Nillable, Sort",
|
||
"description": "The number of hard bounced emails for this user in the day."
|
||
},
|
||
"AllEmailsNotDeliveredCount": {
|
||
"type": "int",
|
||
"properties": "Filter, Group, Nillable, Sort",
|
||
"description": "The number of emails that were undelivered for all recipients on the email. Available in API version 54.0 and later. This is a calculated field."
|
||
},
|
||
"AllEmailsOutOfOfficeCount": {
|
||
"type": "int",
|
||
"properties": "Filter, Group, Nillable, Sort",
|
||
"description": "The number of emails that triggered an out-of-office reply for this user in the day."
|
||
},
|
||
"AllEmailsSentCount": {
|
||
"type": "int",
|
||
"properties": "Filter, Group, Nillable, Sort",
|
||
"description": "The number of emails sent by this user 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 user in the day."
|
||
},
|
||
"AllEmailsTrackedSentCount": {
|
||
"type": "int",
|
||
"properties": "Filter, Group, Nillable, Sort",
|
||
"description": "The number of emails sent by this user with engagement tracking enabled in the day."
|
||
},
|
||
"AllEmailsUntrackedSentCount": {
|
||
"type": "int",
|
||
"properties": "Filter, Group, Nillable, Sort",
|
||
"description": "The number of emails sent by this user without engagement tracking enabled in the day."
|
||
},
|
||
"AllTotalCallsCount": {
|
||
"type": "int",
|
||
"properties": "Filter, Group, Nillable, Sort",
|
||
"description": "The total number of calls by this user 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 with hard bounce tracking. Available in API version 53.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 53.0 and later."
|
||
},
|
||
"OpenTrackableSends": {
|
||
"type": "int",
|
||
"properties": "Filter, Group, Nillable, Sort",
|
||
"description": "The number of emails sent with open tracking. Available in API version 53.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 53.0 and later."
|
||
},
|
||
"RecipientReplies": {
|
||
"type": "int",
|
||
"properties": "Filter, Group, Nillable, Sort",
|
||
"description": "The number of unique recipients who responded to an email. Available in API version 53.0 and later."
|
||
},
|
||
"RecipientSends": {
|
||
"type": "int",
|
||
"properties": "Filter, Group, Nillable, Sort",
|
||
"description": "The number of unique recipients who were sent an email. Available in API version 53.0 and later."
|
||
},
|
||
"ReplyTrackableRecipientSends": {
|
||
"type": "int",
|
||
"properties": "Filter, Group, Nillable, Sort",
|
||
"description": "The number of recipients who were sent an email with reply tracking. Available in API version 53.0 and later."
|
||
},
|
||
"ReplyTrackableSends": {
|
||
"type": "int",
|
||
"properties": "Filter, Group, Nillable, Sort",
|
||
"description": "The number of emails sent with reply 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 53.0 and later."
|
||
},
|
||
"SomeEmailsDeliveredCount": {
|
||
"type": "int",
|
||
"properties": "Filter, Group, Nillable, Sort",
|
||
"description": "The number of emails that were successfully delivered to at least one recipient on the email. Available in API version 54.0 and later. This is a calculated field."
|
||
},
|
||
"SomeEmailsDeliveredRate": {
|
||
"type": "percent",
|
||
"properties": "Filter, Nillable, Sort",
|
||
"description": "The percentage of emails that were successfully delivered to at least one recipient on the email. Available in API version 54.0 and later. This 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 53.0 and later. This 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 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 53.0 and later. This is a calculated field."
|
||
},
|
||
"TrackableSendOpenRate": {
|
||
"type": "percent",
|
||
"properties": "Filter, Nillable, Sort",
|
||
"description": "The percentage of emails sent with open tracking that were opened by a recipient. Available in API version 53.0 and later. This 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 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 53.0 and later. This 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 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 sent by the user on the day."
|
||
},
|
||
"UniqueEmailsOpenedCount": {
|
||
"type": "int",
|
||
"properties": "Filter, Group, Nillable, Sort",
|
||
"description": "The number of unique recipients who opened an email sent by the user on the day."
|
||
},
|
||
"UniqueEmailsRepliedCount": {
|
||
"type": "int",
|
||
"properties": "Filter, Group, Nillable, Sort",
|
||
"description": "The number of unique recipients who replied to an email sent by the user on the day."
|
||
},
|
||
"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"
|
||
}
|
||
},
|
||
"special_access_rules": "Sales Engagement must be enabled.",
|
||
"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.\n\n- **UserDailyMetricOwnerSharingRule**: Sharing rules are available for the object.\n- **UserDailyMetricShare**: Sharing is available for the object.",
|
||
"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"
|
||
},
|
||
"AllEmailsHardBouncedCount": {
|
||
"field_label": "All Emails Hard Bounced Count",
|
||
"type": "int",
|
||
"digits": "9"
|
||
},
|
||
"AllEmailsNotDeliveredCount": {
|
||
"field_label": "All Emails Not Delivered 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": "User Daily 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"
|
||
},
|
||
"OpenTrackableSends": {
|
||
"field_label": "Open Trackable Sends",
|
||
"type": "int",
|
||
"digits": "9"
|
||
},
|
||
"OutOfOfficeTrackableSends": {
|
||
"field_label": "Out Of Office Trackable Sends",
|
||
"type": "int",
|
||
"digits": "9"
|
||
},
|
||
"OwnerId": {
|
||
"field_label": "Owner ID",
|
||
"type": "reference",
|
||
"length": "18"
|
||
},
|
||
"RecipientReplies": {
|
||
"field_label": "Recipient Replies",
|
||
"type": "int",
|
||
"digits": "9"
|
||
},
|
||
"RecipientSends": {
|
||
"field_label": "Recipient Sends",
|
||
"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"
|
||
},
|
||
"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"
|
||
},
|
||
"TrackableRecipientSendReplyRt": {
|
||
"field_label": "Trackable Recipient Send Reply 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 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"
|
||
},
|
||
"UserId": {
|
||
"field_label": "User ID",
|
||
"type": "reference",
|
||
"length": "18"
|
||
}
|
||
},
|
||
"field_reference_columns": [
|
||
"field_label",
|
||
"type",
|
||
"digits",
|
||
"length",
|
||
"precision",
|
||
"scale"
|
||
]
|
||
} |