This article lists all of the objects and fields related to email campaigns and system emails in the communities data lake.
campaigns_campaign_activated (fact)
This object table contains a list of fields related to when email campaign was activated.
| Field Name | Field Type | Field Description |
|---|---|---|
| community_id | string | Contains the community ID where the activity was executed |
| correlation_id | string | Refers to a unique identifier used to correlate and track related actions within the community platform, used for debugging or monitoring purposes |
| occurred_at | string | Refers to the timestamp indicating the precise moment when the activity took place |
| executed_by | string | Identifies the person who executed the activity (zero, if system event) |
| user_id | string | Refers to the unique identifier of the person that identifies the user platform-wide |
| campaign_id | string | Refers to the unique identifier assigned to a specific email campaign within community |
campaigns_campaign_completed (fact)
This object table contains a list of fields related to when email campaign completed.
| Field Name | Field Type | Field Description |
|---|---|---|
| community_id | string | Contains the community ID where the activity was executed |
| correlation_id | string | Refers to a unique identifier used to correlate and track related actions within the community platform, used for debugging or monitoring purposes |
| occurred_at | string | Refers to the timestamp indicating the precise moment when the activity took place |
| executed_by | string | Identifies the person who executed the activity (zero, if system event) |
| user_id | string | Refers to the unique identifier of the person that identifies the user platform-wide |
| campaign_id | string | Refers to the unique identifier assigned to a specific email campaign within community |
campaigns_campaign_created (fact)
This object table contains a list of fields related to when email campaign was created.
| Field Name | Field Type | Field Description |
|---|---|---|
| community_id | string | Contains the community ID where the activity was executed |
| correlation_id | string | Refers to a unique identifier used to correlate and track related actions within the community platform, used for debugging or monitoring purposes |
| occurred_at | string | Refers to the timestamp indicating the precise moment when the activity took place |
| executed_by | string | Identifies the person who executed the activity (zero, if system event) |
| user_id | string | Refers to the unique identifier of the person that identifies the user platform-wide |
| campaign_id | string | Refers to the unique identifier assigned to a specific email campaign within community |
| campaign_type | string | Refers to the classification or category of the campaign which can be: 1- one-off or 3- automated |
| creation_date | string | Contains the timestamp when the campaign was created |
| email_address | string | The email that is configured to be the sender address for campaigns; webmaster address is used. |
| external_id | string | Represents a unique identifier assigned to the campaign by the external system and facilitates tracking by linking the campaign to corresponding records in internal system. |
| message | string | Contains the content or body of the campaign communication |
| recipients | string | Refers to the list specific criteria and filters applied that determine user's eligibility for the campaign. |
| scheduled_at | string | Refers to the date and time when the campaign is planned to be sent |
| subject | string | Represents the name or headline of the email sent with the campaign |
| title | string | Represents the name or headline of the campaign, providing a concise and descriptive identifier that communicates the purpose, theme, or focus of the campaign |
campaigns_campaign_recipients_changed (fact)
This object table contains a list of fields related to when email recipient of email campaign changed.
| Field Name | Field Type | Field Description |
|---|---|---|
| community_id | string | Contains the community ID where the activity was executed |
| correlation_id | string | Refers to a unique identifier used to correlate and track related actions within the community platform, used for debugging or monitoring purposes |
| occurred_at | string | Refers to the timestamp indicating the precise moment when the activity took place |
| executed_by | string | Identifies the person who executed the activity (zero, if system event) |
| user_id | string | Refers to the unique identifier of the person that identifies the user platform-wide |
| campaign_id | string | Refers to the unique identifier assigned to a specific email campaign within community |
| old_recipients | string | Refers to previous the list specific criteria and filters applied that determine user's eligibility for the campaign. |
| new_recipients | string | Refers to the new list specific criteria and filters applied that determine user's eligibility for the campaign. |
campaigns_campaign_scheduled (fact)
This object table contains a list of fields related to when email campaign was scheduled.
| Field Name | Field Type | Field Description |
|---|---|---|
| community_id | string | Contains the community ID where the activity was executed |
| correlation_id | string | Refers to a unique identifier used to correlate and track related actions within the community platform, used for debugging or monitoring purposes |
| occurred_at | string | Refers to the timestamp indicating the precise moment when the activity took place |
| executed_by | string | Identifies the person who executed the activity (zero, if system event) |
| user_id | string | Refers to the unique identifier of the person that identifies the user platform-wide |
| campaign_id | string | Refers to the unique identifier assigned to a specific email campaign within community |
| scheduled_at | string | Refers to the date and time when the campaign is planned to be sent or executed |
| external_id | string | Represents a unique identifier assigned to the campaign by the external system and facilitates tracking by linking the campaign to corresponding records in internal system. |
campaigns_campaign_title_changed (fact)
This object table contains a list of fields related to when email campaign title was changed.
| Field Name | Field Type | Field Description |
|---|---|---|
| community_id | string | Contains the community ID where the activity was executed |
| correlation_id | string | Refers to a unique identifier used to correlate and track related actions within the community platform, used for debugging or monitoring purposes |
| occurred_at | string | Refers to the timestamp indicating the precise moment when the activity took place |
| executed_by | string | Identifies the person who executed the activity (zero, if system event) |
| user_id | string | Refers to the unique identifier of the person that identifies the user platform-wide |
| campaign_id | string | Refers to the unique identifier assigned to a specific email campaign within community |
| old_title | string | Represents previous name or headline of the campaign, providing a concise and descriptive identifier that communicates the purpose, theme, or focus of the campaign |
| new_title | string | Represents new name or headline of the campaign, providing a concise and descriptive identifier that communicates the purpose, theme, or focus of the campaign |
campaigns_email_recipient_unsubscribed (fact)
This object table contains a list of fields related to when email recipient unsubscribed from email campaign.
| Field Name | Field Type | Field Description |
|---|---|---|
| community_id | string | Contains the community ID where the activity was executed |
| correlation_id | string | Refers to a unique identifier used to correlate and track related actions within the community platform, used for debugging or monitoring purposes |
| occurred_at | string | Refers to the timestamp indicating the precise moment when the activity took place |
| executed_by | string | Identifies the person who executed the activity (zero, if system event) |
| user_id | string | Refers to the unique identifier of the person that identifies the user platform-wide |
| campaign_id | string | Refers to the unique identifier assigned to a specific email campaign within community |
| arrival_timestamp | string | Refers to the date and time when the unsubscribe request was received by the system |
| event_timestamp | string | Indicates the date and time when the specific unsubscribe event occurred |
campaigns_user_opted_in_for_email_campaigns (fact)
This object table contains a list of fields related to when a user opts in to receive email campaign.
| Field Name | Field Type | Field Description |
|---|---|---|
| community_id | string | Contains the community ID where the activity was executed |
| correlation_id | string | Refers to a unique identifier used to correlate and track related actions within the community platform, used for debugging or monitoring purposes |
| occurred_at | string | Refers to the timestamp indicating the precise moment when the activity took place |
| opt_out | string | Indicates whether a user has chosen to unsubscribe from receiving emails from campaigns |
| user_id | string | Refers to the unique identifier of the person that identifies the user platform-wide |
| executed_by | string | Identifies the person who executed the activity (zero, if system event) |
campaigns_user_opted_out_for_email_campaigns (fact)
This object table contains a list of fields related to when a user opts out of receiving email campaign.
| Field Name | Field Type | Field Description |
|---|---|---|
| community_id | string | Contains the community ID where the activity was executed |
| correlation_id | string | Refers to a unique identifier used to correlate and track related actions within the community platform, used for debugging or monitoring purposes |
| occurred_at | string | Refers to the timestamp indicating the precise moment when the activity took place |
| opt_out | string | Indicates whether a user has chosen to unsubscribe from receiving emails from campaigns |
| user_id | string | Refers to the unique identifier of the person that identifies the user platform-wide |
| executed_by | string | Identifies the person who executed the activity (zero, if system event) |
subscriptions_subscribed_to_system_email (fact)
This object table contains a list of fields related to when a user subscribes to receive system emails.
| Field Name | Field Type | Field Description |
|---|---|---|
| community_id | string | Contains the community ID where the activity was executed |
| correlation_id | string | Refers to a unique identifier used to correlate and track related actions within the community platform, used for debugging or monitoring purposes |
| occurred_at | string | Refers to the timestamp indicating the precise moment when the activity took place |
| subscribed_to | string | Indicates the specific type of communication stream to which the user has opted in |
| user_id | string | Refers to the unique identifier of the person that identifies the user platform-wide |
| executed_by | string | Identifies the person who executed the activity (zero, if system event) |
| string | Represents the email address of the user who has subscribed to receiving system emails | |
| method | string | Indicates how the user subscribed to the system emails |
subscriptions_unsubscribed_from_system_email (fact)
This object table contains a list of fields related to when a user unsubscribes from receiving system emails.
| Field Name | Field Type | Field Description |
|---|---|---|
| community_id | string | Contains the community ID where the activity was executed |
| correlation_id | string | Refers to a unique identifier used to correlate and track related actions within the community platform, used for debugging or monitoring purposes |
| occurred_at | string | Refers to the timestamp indicating the precise moment when the activity took place |
| unsubscribed_from | string | Indicates the specific type of communication stream from which the user has opted out |
| user_id | string | Refers to the unique identifier of the person that identifies the user platform-wide |
| executed_by | string | Identifies the person who executed the activity (zero, if system event) |
| string | Represents the email address of the user who has unsubscribed from receiving system emails | |
| method | string | Indicates how the user unsubscribed from the system emails |