Skip to main content

Documentation Index

Fetch the complete documentation index at: https://developer.voyado.com/llms.txt

Use this file to discover all available pages before exploring further.

The Message Services product focuses on email and SMS data, offering insights into message performance and user engagement. It is pivotal for optimizing communication strategies and measuring campaign effectiveness. Some use cases are:
  • Enhancing communication strategy with performance insights
  • Calculating engagement metrics for emails and SMS

email_click

Tenant column:tenant_id
Description: The table contains data related to messaging events, capturing details such as the tenant, message identifiers, and user interactions. It includes information on the type and category of events, timestamps for when events occurred, and metadata like IP addresses and user agents. This data can be used for analyzing messaging performance, tracking user engagement, and troubleshooting delivery issues.
Column nameType
tenant_idSTRING
message_idSTRING
emailSTRING
eventSTRING
typeSTRING
categorySTRING
event_timestampSTRING
contact_idSTRING
delivery_idSTRING
ip_addressSTRING
urlSTRING
user_agentSTRING
link_idSTRING
kafka_timestampTIMESTAMP
write_timestampTIMESTAMP

email_bounce

Tenant column:tenant_id
Description: The table contains data related to email events, including information about message delivery, bounces, and associated metadata. Use cases include tracking email performance, analyzing bounce reasons, and understanding user engagement through event timestamps. The data can help in optimizing email campaigns and improving communication strategies.
Column nameType
tenant_idSTRING
message_idSTRING
emailSTRING
eventSTRING
typeSTRING
reasonSTRING
bounce_typeSTRING
event_timestampSTRING
contact_idSTRING
delivery_idSTRING
ip_addressSTRING
message_classSTRING
send_timeSTRING
kafka_timestampTIMESTAMP
write_timestampTIMESTAMP

message_base

Tenant column:tenant_id
Description: The table contains data related to messaging activities within the system. It includes details such as the message ID, recipient count, and status of each message. This data can be used to analyze messaging performance, track automation activities, and understand the effectiveness of different marketing groups. Additionally, timestamps for various events provide insights into the timing of message sends and their scheduling.
Column nameType
tenant_idSTRING
message_idSTRING
nameSTRING
subjectSTRING
automation_definition_idSTRING
automation_activity_definition_idSTRING
content_idSTRING
sendout_idSTRING
marketing_group_idSTRING
is_transactionalBOOLEAN
recipient_countLONG
statusSTRING
created_timeTIMESTAMP
scheduled_send_timeTIMESTAMP
last_scheduled_send_timeTIMESTAMP
payload_timestampTIMESTAMP
enqueued_timeTIMESTAMP
message_typeSTRING
event_tsTIMESTAMP

email_open

Tenant column:tenant_id
Description: This table contains data related to email opens, including information about the tenant, contact, and email message, as well as details about the device and time of the open event. Its likely purpose is to track and store email engagement metrics, allowing for analysis of email campaign effectiveness and user behavior. This data can be used for various purposes, such as generating reports on email open rates, identifying trends in user engagement, and informing future email marketing strategies.
Column nameType
tenant_idSTRING
eventSTRING
contact_idSTRING
message_idSTRING
delivery_idSTRING
emailSTRING
user_agentSTRING
kafka_timestampTIMESTAMP
event_timeTIMESTAMP
event_dateDATE
write_timestampTIMESTAMP

email_delivered

Tenant column:tenant_id
Description: This table contains data related to email delivery events, including information about the recipient, email message, and delivery details, as well as timestamps for when the event occurred and was written to the table. Its likely purpose is to track and store email delivery metrics for analysis and reporting, allowing users to monitor email campaign effectiveness and troubleshoot delivery issues. Potential use cases for this table include generating reports on email delivery rates, analyzing user engagement based on user agent data, and identifying trends in email delivery times and dates.
Column nameType
tenant_idSTRING
eventSTRING
contact_idSTRING
message_idSTRING
delivery_idSTRING
emailSTRING
user_agentSTRING
kafka_timestampTIMESTAMP
event_timeTIMESTAMP
event_dateDATE
write_timestampTIMESTAMP

email_unsubscribe

Tenant column:tenant_id
Description: This table contains data related to email unsubscribe events, including information about the tenant, contact, and email message, as well as details about the event itself, such as the user agent and timestamps. The likely purpose of this table is to track and store unsubscribe events for analytics and compliance purposes, allowing businesses to manage their email marketing campaigns effectively. Potential use cases for this table include monitoring unsubscribe rates, analyzing user behavior, and ensuring compliance with anti-spam laws and regulations.
Column nameType
tenant_idSTRING
eventSTRING
contact_idSTRING
message_idSTRING
delivery_idSTRING
emailSTRING
user_agentSTRING
kafka_timestampTIMESTAMP
event_timeTIMESTAMP
event_dateDATE
write_timestampTIMESTAMP

sms_delivered

Tenant column:tenant_id
Description: This table contains data related to the delivery of SMS messages, including the tenant, contact, and message details, as well as timestamps for when the event occurred and was written to the table. Its likely purpose is to track and record the delivery status of SMS messages for auditing, analytics, and troubleshooting purposes. This data can be used to monitor message delivery rates, identify issues with message delivery, and analyze the performance of SMS campaigns.
Column nameType
tenant_idSTRING
eventSTRING
contact_idSTRING
message_idSTRING
delivery_idSTRING
kafka_timestampTIMESTAMP
event_timeTIMESTAMP
event_dateDATE
write_timestampTIMESTAMP

sms_unsubscribe

Tenant column:tenant_id
Description: This table contains data related to SMS unsubscribe events, including the tenant, message, and contact information, as well as timestamps for when the unsubscribe event occurred, when the message was sent, and when it was enqueued. The likely purpose of this table is to track and store unsubscribe events for SMS messages, allowing for compliance with regulations and management of contact preferences. This data can be used for analytics, auditing, and ensuring that contacts are not sent messages they have opted out of receiving, helping to maintain a positive user experience and prevent spam.
Column nameType
tenant_idSTRING
message_idSTRING
contact_idSTRING
unsubscribe_timeTIMESTAMP
payload_timestampTIMESTAMP
enqueued_timeTIMESTAMP
message_typeSTRING
event_tsTIMESTAMP

sendout

Tenant column:tenant_id
Description: This table contains data related to exported sendouts, including the tenant identifier, message type, and a JSON object with additional values, as well as a unique sendout identifier and the timestamp of the event. The likely purpose of this table is to store a record of all sendouts that have been exported, allowing for auditing and tracking of these events. This data can be used for analytics, debugging, and logging purposes, such as monitoring sendout volumes, identifying trends, and troubleshooting issues with the export process.
Column nameType
tenant_idSTRING
value_jsonVARIANT
message_typeSTRING
sendout_idSTRING
event_timeTIMESTAMP

marketing_group

Tenant column:tenant_id
Description: This table contains data related to marketing group exports, including tenant information, JSON-formatted values, message types, and timestamps of when events occurred. Its likely purpose is to store and track the history of marketing group exports for various tenants, allowing for auditing and analytics. Potential use cases for this table include monitoring export activity, troubleshooting issues, and analyzing marketing group data for business insights.
Column nameType
tenant_idSTRING
value_jsonVARIANT
message_typeSTRING
event_timeTIMESTAMP