Schema Information for Klaviyo
Schema Information for Klaviyo
In this article, we will look at the schema information of the supported APIs and tables for Klaviyo.
Find the links to other articles related to Klaviyo Below:
- Essential Attributes and Supported Tables for Klaviyo
- Setup Instructions for Klaviyo
- Authentication Credentials for Klaviyo
Tables/APIs
The following is the list of tables or APIs associated with the Klaviyo connector:
Metrics
Purpose: This API is used to fetch all metrics in the account
Source API Documentation: https://developers.klaviyo.com/en/reference/get_metrics
Replication: Full Replication
Replication Key: NA
Fields
Name |
Data Type |
---|---|
type |
STRING |
id |
STRING |
attributes |
RECORD |
links |
RECORD |
Lists
Purpose: This API is used to fetch all lists in the account
Source API Documentation: https://developers.klaviyo.com/en/reference/get_lists
Replication: Full Replication
Replication Key: NA
Fields
Name |
Data Type |
---|---|
type |
STRING |
id |
STRING |
attributes |
RECORD |
links |
RECORD |
Segments
Purpose: This API is used to fetch all segments in the account
Source API Documentation: https://developers.klaviyo.com/en/reference/get_segments
Replication: Full Replication
Replication Key: NA
Fields
Name |
Data Type |
---|---|
type |
STRING |
id |
STRING |
attributes |
RECORD |
links |
RECORD |
Profiles
Purpose: This API is used to fetch all profiles in the account
Source API Documentation: https://developers.klaviyo.com/en/reference/get_profiles
Replication: Full Replication
Replication Key: NA
Fields
Name |
Data Type |
---|---|
type |
STRING |
id |
STRING |
attributes |
RECORD |
links |
RECORD |
Flows
Purpose: This API is used to fetch all flows
Source API Documentation: https://developers.klaviyo.com/en/reference/get_flows
Replication: Full Replication
Replication Key: NA
Fields
Name |
Data Type |
---|---|
type |
STRING |
id |
STRING |
attributes |
RECORD |
links |
RECORD |
Flow Actions
Purpose: This API is used to fetch all flow actions for the flows
Source API Documentation: https://developers.klaviyo.com/en/reference/get_flow_flow_actions
Replication: Full Replication
Replication Key: NA
Fields
Name |
Data Type |
---|---|
type |
STRING |
id |
STRING |
attributes |
RECORD |
links |
RECORD |
Flow Messages
Purpose: This API is used to fetch all flow messages for the flow actions
Source API Documentation:https://developers.klaviyo.com/en/reference/get_flow_action_messages
Replication: Full Replication
Replication Key: NA
Fields
Name |
Data Type |
---|---|
type |
STRING |
id |
STRING |
attributes |
RECORD |
links |
RECORD |
Templates
Purpose: This API is used to fetch all templates in the account
Source API Documentation: https://developers.klaviyo.com/en/reference/get_templates
Replication: Key Based Incremental
Replication Key: greater-or-equal, less-or-equal
Fields
Name |
Data Type |
---|---|
type |
STRING |
id |
STRING |
attributes |
RECORD |
links |
RECORD |
Active On Site
Purpose: This API is used to fetch all events of Active On Site metric
Source API Documentation: https://developers.klaviyo.com/en/reference/get_events
Replication: Key Based Incremental
Replication Key: greater-or-equal, less-or-equal
Fields
Name |
Data Type |
---|---|
type |
STRING |
id |
STRING |
attributes |
RECORD |
links |
RECORD |
Bounced Email
Purpose: This API is used to fetch all events of Bounced Email metric
Source API Documentation: https://developers.klaviyo.com/en/reference/get_events
Replication: Key Based Incremental
Replication Key: greater-or-equal, less-or-equal
Fields
Name |
Data Type |
---|---|
type |
STRING |
id |
STRING |
attributes |
RECORD |
links |
RECORD |
Cancelled Order
Purpose: This API is used to fetch all events of Cancelled Order metric of Shopify
Replication: Key Based Incremental
Replication Key: greater-or-equal, less-or-equal
Fields
Name |
Data Type |
---|---|
type |
STRING |
id |
STRING |
attributes |
RECORD |
links |
RECORD |
Clicked SMS
Purpose: This API is used to fetch all events of Clicked SMS metric
Source API Documentation: https://developers.klaviyo.com/en/reference/get_events
Replication: Key Based Incremental
Replication Key: greater-or-equal, less-or-equal
Fields
Name |
Data Type |
---|---|
type |
STRING |
id |
STRING |
attributes |
RECORD |
links |
RECORD |
Clicked Email
Purpose: This API is used to fetch all events of Clicked Email metric
Source API Documentation: https://developers.klaviyo.com/en/reference/get_events
Replication: Key Based Incremental
Replication Key: greater-or-equal, less-or-equal
Fields
Name |
Data Type |
---|---|
type |
STRING |
id |
STRING |
attributes |
RECORD |
links |
RECORD |
Consented To Receive SMS
Purpose: This API is used to fetch all events of Consented To Receive SMS metric
Source API Documentation: https://developers.klaviyo.com/en/reference/get_events
Replication: Key Based Incremental
Replication Key: greater-or-equal, less-or-equal
Fields
Name |
Data Type |
---|---|
type |
STRING |
id |
STRING |
attributes |
RECORD |
links |
RECORD |
Dropped Email
Purpose: This API is used to fetch all events of Dropped Email metric
Source API Documentation: https://developers.klaviyo.com/en/reference/get_events
Replication: Key Based Incremental
Replication Key: greater-or-equal, less-or-equal
Fields
Name |
Data Type |
---|---|
type |
STRING |
id |
STRING |
attributes |
RECORD |
links |
RECORD |
Failed To Deliver Automated Response SMS
Purpose: This API is used to fetch all events of Failed To Deliver Automated Response SMS metric
Source API Documentation: https://developers.klaviyo.com/en/reference/get_events
Replication: Key Based Incremental
Replication Key: greater-or-equal, less-or-equal
Fields
Name |
Data Type |
---|---|
type |
STRING |
id |
STRING |
attributes |
RECORD |
links |
RECORD |
Failed To Deliver SMS
Purpose: This API is used to fetch all events of Failed To Deliver SMS metric
Source API Documentation: https://developers.klaviyo.com/en/reference/get_events
Replication: Key Based Incremental
Replication Key: greater-or-equal, less-or-equal
Fields
Name |
Data Type |
---|---|
type |
STRING |
id |
STRING |
attributes |
RECORD |
links |
RECORD |
Marked Email As Spam
Purpose: This API is used to fetch all events of Marked Email As Spam metric
Source API Documentation: https://developers.klaviyo.com/en/reference/get_events
Replication: Key Based Incremental
Replication Key: greater-or-equal, less-or-equal
Fields
Name |
Data Type |
---|---|
type |
STRING |
id |
STRING |
attributes |
RECORD |
links |
RECORD |
Merged Profile
Purpose: This API is used to fetch all events of Merged Profile metric
Source API Documentation: https://developers.klaviyo.com/en/reference/get_events
Replication: Key Based Incremental
Replication Key: greater-or-equal, less-or-equal
Fields
Name |
Data Type |
---|---|
type |
STRING |
id |
STRING |
attributes |
RECORD |
links |
RECORD |
Opened Email
Purpose: This API is used to fetch all events of Opened Email metric
Source API Documentation: https://developers.klaviyo.com/en/reference/get_events
Replication: Key Based Incremental
Replication Key: greater-or-equal, less-or-equal
Field
Name |
Data Type |
---|---|
type |
STRING |
id |
STRING |
attributes |
RECORD |
links |
RECORD |
Opened Push
Purpose: This API is used to fetch all events of Opened Push metric
Source API Documentation: https://developers.klaviyo.com/en/reference/get_events
Replication: Key Based Incremental
Replication Key: greater-or-equal, less-or-equal
Fields
Name |
Data Type |
---|---|
type |
STRING |
id |
STRING |
attributes |
RECORD |
links |
RECORD |
Placed Order
Purpose: This API is used to fetch all events of Placed Order metric of Shopify
Source API Documentation: https://developers.klaviyo.com/en/reference/get_events
Replication: Key Based Incremental
Replication Key: greater-or-equal, less-or-equal
Fields
Name |
Data Type |
---|---|
type |
STRING |
id |
STRING |
attributes |
RECORD |
links |
RECORD |
Received Automated Response SMS
Purpose: This API is used to fetch all events of Received Automated Response SMS metric
Source API Documentation: https://developers.klaviyo.com/en/reference/get_events
Replication: Key Based Incremental
Replication Key: greater-or-equal, less-or-equal
Fields
Name |
Data Type |
---|---|
type |
STRING |
id |
STRING |
attributes |
RECORD |
links |
RECORD |
Received Email
Purpose: This API is used to fetch all events of Received Email metric
Source API Documentation: https://developers.klaviyo.com/en/reference/get_events
Replication: Key Based Incremental
Replication Key: greater-or-equal, less-or-equal
Field
Name |
Data Type |
---|---|
type |
STRING |
id |
STRING |
attributes |
RECORD |
links |
RECORD |
Received Push
Purpose: This API is used to fetch all events of Received Push metric
Source API Documentation: https://developers.klaviyo.com/en/reference/get_events
Replication: Key Based Incremental
Replication Key: greater-or-equal, less-or-equal
Fields
Name |
Data Type |
---|---|
type |
STRING |
id |
STRING |
attributes |
RECORD |
links |
RECORD |
Received SMS
Purpose: This API is used to fetch all events of Received SMS metric
Source API Documentation: https://developers.klaviyo.com/en/reference/get_events
Replication: Key Based Incremental
Replication Key: greater-or-equal, less-or-equal
Fields
Name |
Data Type |
---|---|
type |
STRING |
id |
STRING |
attributes |
RECORD |
links |
RECORD |
Refunded Order
Purpose: This API is used to fetch all events of Refunded Order metric of Shopify
Source API Documentation: https://developers.klaviyo.com/en/reference/get_events
Replication: Key Based Incremental
Replication Key: greater-or-equal, less-or-equal
Fields
Name |
Data Type |
---|---|
type |
STRING |
id |
STRING |
attributes |
RECORD |
links |
RECORD |
Sent SMS
Purpose: This API is used to fetch all events of Sent SMS metric
Source API Documentation: https://developers.klaviyo.com/en/reference/get_events
Replication: Key Based Incremental
Replication Key: greater-or-equal, less-or-equal
Fields
Name |
Data Type |
---|---|
type |
STRING |
id |
STRING |
attributes |
RECORD |
links |
RECORD |
Subscribed To Back In Stock
Purpose: This API is used to fetch all events of Subscribed To Back In Stock metric
Source API Documentation: https://developers.klaviyo.com/en/reference/get_events
Replication: Key Based Incremental
Replication Key: greater-or-equal, less-or-equal
Fields
Name |
Data Type |
---|---|
type |
STRING |
id |
STRING |
attributes |
RECORD |
links |
RECORD |
Subscribed To List
Purpose: This API is used to fetch all events of Subscribed To List metric
Source API Documentation: https://developers.klaviyo.com/en/reference/get_events
Replication: Key Based Incremental
Replication Key: greater-or-equal, less-or-equal
Fields
Name |
Data Type |
---|---|
type |
STRING |
id |
STRING |
attributes |
RECORD |
links |
RECORD |
Unsubscribed
Purpose: This API is used to fetch all events of Unsubscribed metric
Source API Documentation: https://developers.klaviyo.com/en/reference/get_events
Replication: Key Based Incremental
Replication Key: greater-or-equal, less-or-equal
Fields
Name |
Data Type |
---|---|
type |
STRING |
id |
STRING |
attributes |
RECORD |
links |
RECORD |
Unsubscribed From List
Purpose: This API is used to fetch all events of Unsubscribed From List metric
Source API Documentation: https://developers.klaviyo.com/en/reference/get_events
Replication: Key Based Incremental
Replication Key: greater-or-equal, less-or-equal
Field
Name |
Data Type |
---|---|
type |
STRING |
id |
STRING |
attributes |
RECORD |
links |
RECORD |
Unsubscribed From SMS
Purpose: This API is used to fetch all events of Unsubscribed From SMS metric
Source API Documentation: https://developers.klaviyo.com/en/reference/get_events
Replication: Key Based Incremental
Replication Key: greater-or-equal, less-or-equal
Fields
Name |
Data Type |
---|---|
type |
STRING |
id |
STRING |
attributes |
RECORD |
links |
RECORD |
Updated Email Preferences
Purpose: This API is used to fetch all events of Updated Email Preferences metric
Source API Documentation: https://developers.klaviyo.com/en/reference/get_events
Replication: Key Based Incremental
Replication Key: greater-or-equal, less-or-equal
Fields
Name |
Data Type |
---|---|
type |
STRING |
id |
STRING |
attributes |
RECORD |
links |
RECORD |