Klaviyo Connector Reference

114 metrics105 dimensions

https://connectors.windsor.ai/klaviyo?api_key=[your API key]&date_preset=last_7d&fields=email,first_name,last_name,organization,created&_renderer=csv

The Klaviyo connector exposes 219 fields (114 metrics, 105 dimensions). Every field ID below can be passed to the Windsor.ai API in the fields parameter.


Available actions


Create Flow Create a Klaviyo flow from a full definition: a trigger plus a graph of action steps (time-delay, send-email, send-sms, conditional-split) wired together by temporary_id. The trigger is either a metric event or being added to a list. entry_action_id is the temporary_id of the first step; each step links to the next by temporary_id (conditional-split uses next_if_true / next_if_false). Email steps reference an existing Klaviyo template by template_id (email content is not authored here); SMS steps carry an inline body. The flow and its messages are created in draft status so nothing sends until you activate it with update_flow_status. Note Klaviyo rate-limits flow creation to about 100 per day.

Create a Klaviyo flow from a full definition: a trigger plus a graph of action steps (time-delay, send-email, send-sms, conditional-split) wired together by temporary_id. The trigger is either a metric event or being added to a list. entry_action_id is the temporary_id of the first step; each step links to the next by temporary_id (conditional-split uses next_if_true / next_if_false). Email steps reference an existing Klaviyo template by template_id (email content is not authored here); SMS steps carry an inline body. The flow and its messages are created in draft status so nothing sends until you activate it with update_flow_status. Note Klaviyo rate-limits flow creation to about 100 per day.

Parameters
namestringRequiredtriggerstringRequiredentry_action_idstringRequiredactionsarrayRequiredprofile_filterstring
Update Flow Status Set a Klaviyo flow's status. 'draft' turns it off (no one enters, nothing sends), 'manual' lets profiles enter but holds messages for manual review, and 'live' sends automatically. The status change applies to the whole flow and all of its actions. The flow id can be obtained from a Klaviyo flows query, the flow's URL in Klaviyo, or the create_flow result.

Set a Klaviyo flow's status. 'draft' turns it off (no one enters, nothing sends), 'manual' lets profiles enter but holds messages for manual review, and 'live' sends automatically. The status change applies to the whole flow and all of its actions. The flow id can be obtained from a Klaviyo flows query, the flow's URL in Klaviyo, or the create_flow result.

Parameters
flow_idstringRequiredstatusstringRequired

Klaviyo Fields

Klaviyo campaign-reports fields

The campaign-reports report of the Klaviyo connector includes 27 fields.

ID Type Name Description
campaign_report_average_order_value NUMERIC Campaign report Average Order Value Campaign report Average Order Value
campaign_report_bounce_rate PERCENT Campaign report Bounce Rate Campaign report Bounce Rate
campaign_report_bounced NUMERIC Campaign report Bounced Campaign report Bounced
campaign_report_bounced_or_failed NUMERIC Campaign report Bounced Or Failed Campaign report Bounced Or Failed
campaign_report_bounced_or_failed_rate PERCENT Campaign report Bounced Or Failed Rate Campaign report Bounced Or Failed Rate
campaign_report_click_rate PERCENT Campaign report Click Rate Campaign report Click Rate
campaign_report_click_to_open_rate PERCENT Campaign report Click To Open Rate Campaign report Click To Open Rate
campaign_report_clicks NUMERIC Campaign report Clicks Campaign report Clicks
campaign_report_clicks_unique NUMERIC Campaign report Clicks Unique Campaign report Clicks Unique
campaign_report_conversion_rate PERCENT Campaign report Conversion Rate Campaign report Conversion Rate
campaign_report_conversion_uniques NUMERIC Campaign report Conversion Uniques Campaign report Conversion Uniques
campaign_report_conversion_value NUMERIC Campaign report Conversion Value Campaign report Conversion Value
campaign_report_conversions NUMERIC Campaign report Conversions Campaign report Conversions
campaign_report_delivered NUMERIC Campaign report Delivered Campaign report Delivered
campaign_report_delivery_rate PERCENT Campaign report Delivery Rate Campaign report Delivery Rate
campaign_report_failed NUMERIC Campaign report Failed Campaign report Failed
campaign_report_failed_rate PERCENT Campaign report Failed Rate Campaign report Failed Rate
campaign_report_open_rate PERCENT Campaign report Open Rate Campaign report Open Rate
campaign_report_opens NUMERIC Campaign report Opens Campaign report Opens
campaign_report_opens_unique NUMERIC Campaign report Opens Unique Campaign report Opens Unique
campaign_report_recipients NUMERIC Campaign report Recipients Campaign report Recipients
campaign_report_revenue_per_recipient NUMERIC Campaign report Revenue Per Recipient Campaign report Revenue Per Recipient
campaign_report_spam_complaint_rate PERCENT Campaign report Spam Complaint Rate Campaign report Spam Complaint Rate
campaign_report_spam_complaints NUMERIC Campaign report Spam Complaints Campaign report Spam Complaints
campaign_report_unsubscribe_rate PERCENT Campaign report Unsubscribe Rate Campaign report Unsubscribe Rate
campaign_report_unsubscribe_uniques NUMERIC Campaign report Unsubscribe Uniques Campaign report Unsubscribe Uniques
campaign_report_unsubscribes NUMERIC Campaign report Unsubscribes Campaign report Unsubscribes

Klaviyo campaigns fields

The campaigns report of the Klaviyo connector includes 11 fields.

ID Type Name Description
campaign TEXT Campaign Name Campaign name
campaign_channel TEXT Campaign Channel Campaign Channel
campaign_id TEXT Campaign ID Campaign id
created TEXT Campaign Created at Campaign creation time
from_email TEXT From E-mail From e-mail
from_name TEXT From Name From name
message_channel TEXT Message Channel Message Channel
sent_at TEXT Sent at Campaign sent time
status TEXT Status Campaign status
subject TEXT Subject Campaign subject
subscription_status TEXT Subscription status Email subscriptions status

Klaviyo events fields

The events report of the Klaviyo connector includes 12 fields.

ID Type Name Description
card_last_four TEXT Card Last Four Last four digits of the card used for the payment, from Stripe Successful Payment and Failed Payment events
card_type TEXT Card Type Card brand used for the payment (e.g. visa, mastercard), from Stripe Successful Payment and Failed Payment events
event_datetime TEXT Event Datetime Time the event occurred, in ISO8601 format
event_name TEXT Event Name Name of the metric the event was tracked for
event_uuid TEXT Event UUID Klaviyo's unique identifier of the event
order_id TEXT Order ID Identifier of the order the event belongs to, for events tracked by an ecommerce or shipping integration
payment_failure_reason TEXT Payment Failure Reason Reason a payment failed (e.g. card declined), from Stripe Failed Payment events
profile_email TEXT Profile Email Email address of the profile the event is associated with
profile_firstname TEXT Profile First Name First name of the profile the event is associated with
profile_id TEXT Profile ID Klaviyo profile/member id the event is associated with; joins with the Members table 'id' field
profile_lastname TEXT Profile Last Name Last name of the profile the event is associated with
refund_amount NUMERIC Refund Amount Amount refunded, from Stripe Refunded Payment events

Klaviyo flows fields

The flows report of the Klaviyo connector includes 37 fields.

ID Type Name Description
flow_archived TEXT Flow Archived Flow Archived
flow_average_order_value NUMERIC Flow Average order value Flow Average order value
flow_bounce_rate PERCENT Flow Bounce rate Flow Bounce rate
flow_bounced NUMERIC Flow Bounced Flow Bounced
flow_bounced_or_failed NUMERIC Flow Bounced or failed Flow Bounced or failed
flow_bounced_or_failed_rate PERCENT Flow Bounced or failed rate Flow Bounced or failed rate
flow_click_rate PERCENT Flow Click rate Flow Click rate
flow_click_to_open_rate PERCENT Flow Click to open rate Flow Click to open rate
flow_clicks NUMERIC Flow Clicks Flow Clicks
flow_clicks_unique NUMERIC Flow Clicks unique Flow Clicks unique
flow_conversion_rate PERCENT Flow Conversion rate Flow Conversion rate
flow_conversion_uniques NUMERIC Flow Conversion uniques Flow Conversion uniques
flow_conversion_value NUMERIC Flow Conversion value Flow Conversion value
flow_conversions NUMERIC Flow Conversions Flow Conversions
flow_created_time TIMESTAMP Flow Created Time Flow Created Time
flow_delivered NUMERIC Flow Delivered Flow Delivered
flow_delivery_rate PERCENT Flow Delivery rate Flow Delivery rate
flow_failed NUMERIC Flow Failed Flow Failed
flow_failed_rate PERCENT Flow Failed rate Flow Failed rate
flow_id TEXT Flow ID Flow ID
flow_message_id TEXT Flow Message ID Flow Message ID
flow_message_name TEXT Flow Message Name Flow Message Name
flow_name TEXT Flow Name Flow Name
flow_open_rate PERCENT Flow Open rate Flow Open rate
flow_opens NUMERIC Flow Opens Flow Opens
flow_opens_unique NUMERIC Flow Opens unique Flow Opens unique
flow_recipients NUMERIC Flow Recipients Flow Recipients
flow_revenue_per_recipient NUMERIC Flow Revenue per recipient Flow Revenue per recipient
flow_spam_complaint_rate PERCENT Flow Spam complaint rate Flow Spam complaint rate
flow_spam_complaints NUMERIC Flow Spam complaints Flow Spam complaints
flow_status TEXT Flow Status Flow Status
flow_trigger_type TEXT Flow Trigger Type Flow Trigger Type
flow_unsubscribe_rate PERCENT Flow Unsubscribe rate Flow Unsubscribe rate
flow_unsubscribe_uniques NUMERIC Flow Unsubscribe uniques Flow Unsubscribe uniques
flow_unsubscribes NUMERIC Flow Unsubscribes Flow Unsubscribes
flow_updated_time TIMESTAMP Flow Updated Time Flow Updated Time
flow_url TEXT Flow URL Flow Url

Klaviyo general fields

The general report of the Klaviyo connector includes 3 fields.

ID Type Name Description
account_id TEXT Account ID Klaviyo account ID
account_name TEXT Account Name Klaviyo account name
date DATE Date Date of metric type data

Klaviyo members fields

The members report of the Klaviyo connector includes 32 fields.

ID Type Name Description
address1 TEXT Address Line 1 The primary address line of the object
address2 TEXT Address Line 2 The secondary address line of the object
city CITY City The city of the object
country COUNTRY Country The country of the object
created_at DATE Created Date/Time The date and time the object was created
dimension_member_count NUMERIC Member Count Member count for current dimension values
email TEXT Email address The email address of the object
firstname TEXT First Name The first name of the object
id TEXT ID The ID of the object
lastname TEXT Last Name The last name of the object
latitude TEXT Latitude The latitude of the object
list_created TIMESTAMP List Create Date List Create Date
list_id TEXT List Id List Id
list_name TEXT List Name List Name
list_profile_count NUMERIC List Profile Count Total number of profiles in the list
list_updated TIMESTAMP List Update Date List Update Date
locale TEXT Locale The locale of the profile
longitude TEXT Longitude The longitude of the object
members_count NUMERIC Account Member Count Total number of members for the whole account
object TEXT Object Type The type of the object (e.g. Person)
organization_name TEXT Organization Name The organization of the object
phone TEXT Phone Number The phone number of the object
region REGION Region The region of the object
segment_created TIMESTAMP Segment Create Date Segment Create Date
segment_id TEXT Segment Id Segment Id
segment_name TEXT Segment Name Segment Name
segment_profile_count NUMERIC Segment Profile Count Total number of profiles in the segment
segment_updated TIMESTAMP Segment Update Date Segment Update Date
timezone TEXT Time Zone The time zone of the object
title TEXT Title The title of the object
updated_at DATE Updated Date/Time The date and time the object was last updated
zip TEXT ZIP Code The zip code of the object

Klaviyo metrics fields

The metrics report of the Klaviyo connector includes 56 fields.

Klaviyo metrics fields (added_to_cart to shopify_marked_out_for_delivery)

ID Type Name Description
added_to_cart NUMERIC Added to Cart Total number of Added to Cart events
bounced_email NUMERIC Bounced Email Bounced Email
bounced_email_rate NUMERIC Bounced Email Rate Bounced Email Rate
cancelled_order NUMERIC Cancelled Order Total amount of Cancelled Order
cancelled_order_value NUMERIC Cancelled Order Value Cancelled Order value
checkout_completed NUMERIC Checkout Completed Checkout Completed
checkout_start_to_order_rate NUMERIC Checkout Start to Order Rate Completed checkouts as ratio of checkout starts
checkout_started NUMERIC Checkout Started Total amount of Checkout Started
checkout_started_value NUMERIC Checkout Started Value Checkout Started value
click_rate PERCENT Click rate Click rate of e-mails
clicked_sms NUMERIC Unique Clicked SMS Number of unique SMS clicks
clicks NUMERIC Clicks Number of unique e-mail clicks
conversions NUMERIC Conversions Total Value of placed orders
conversions_avg_value PERCENT Average Conversion Value Average value of placed orders
dimensions TEXT Flow dimensions Flow dimensions
failed_to_deliver_sms NUMERIC Failed To Deliver SMS Number of SMS messages that failed to deliver
fulfilled_order NUMERIC Fulfilled Order Total amount of Fulfilled Order
fulfilled_order_value NUMERIC Fulfilled Order Value Fulfilled Order value
fulfilled_partial_order NUMERIC Fulfilled Partial Order Total amount of Fulfilled Partial Order
fulfilled_partial_order_value NUMERIC Fulfilled Partial Order Value Fulfilled Order value
open_rate PERCENT Open rate Open rate of E-mails
opens NUMERIC Opens Number of unique e-mail opens
ordered_product NUMERIC Ordered Product Total amount of Ordered product
ordered_product_avg_value PERCENT Ordered Product Average Value Ordered product average value
ordered_product_value NUMERIC Ordered Product Value Ordered product value
received_emails NUMERIC Received e-mails Number of e-mails received
received_sms NUMERIC Received SMS Number of unique SMS messages received
refunded_order NUMERIC Refunded Order Total amount of Refunded Order
refunded_order_value NUMERIC Refunded Order Value Refunded Order value
revenue NUMERIC Revenue Total Value of placed orders
revenue_per_recipient NUMERIC Revenue per Recipient The amount of revenue attributed to a campaign divided by the number of recipients
sent_emails NUMERIC Sent Emails The number of recipients the email was sent to
sent_sms NUMERIC Sent SMS Number of SMS messages sent
shopify_cancelled_order NUMERIC Shopify Cancelled Order This event is tracked when a customer creates an order in your Shopify store but then cancels the order before fulfillment
shopify_checkout_started NUMERIC Shopify Checkout Started Shopify checkout completed
shopify_confirmed_shipment NUMERIC Shopify Confirmed Shipment Shopify Confirmed Shipment
shopify_delivered_shipment NUMERIC Shopify Delivered Shipment Shopify Delivered Shipment
shopify_fulfilled_order NUMERIC Shopify Fulfilled Order This event is tracked when an order is marked as 'fulfilled' in your Shopify store
shopify_fulfilled_partial_order NUMERIC Shopify Fulfilled Partial Order This event is tracked when an order is marked as 'fulfilled' in your Shopify store
shopify_marked_out_for_delivery NUMERIC Shopify Marked Out for Delivery Shopify Marked Out for Delivery

Klaviyo metrics fields (shopify_ordered_product to viewed_product)

ID Type Name Description
shopify_ordered_product NUMERIC Shopify Ordered Product The total quantity ordered of the product
shopify_placed_order NUMERIC Shopify Placed Order This event is tracked when a customer completes the checkout process and creates an order in your Shopify store
shopify_refunded_order NUMERIC Shopify Refunded Order This event is tracked when a customer completes the checkout process in your Shopify store and a payment is made, but the customer requests the payment to be returned. Klaviyo only receives events from fully refunded orders (not partially refunded orders)
shopify_revenue NUMERIC Shopify Revenue Revenue value from Shopify Placed Order events.
sms_click_rate PERCENT SMS Click Rate Unique SMS clicks divided by SMS received
sms_unsubscribes NUMERIC Unsubscribed From SMS Number of SMS marketing unsubscribes
subscribed NUMERIC Subscribed to List Subscribed to List
total_clicked_sms NUMERIC Total Clicked SMS Total number of SMS clicks
total_clicks NUMERIC Total Clicks Total number of e-mail clicks
total_conversions NUMERIC Total Conversions Total amount of placed orders
total_opens NUMERIC Total Opens Total number of e-mail opens
unsubscribed NUMERIC Unsubscribed From List Unsubscribed from list
unsubscribed_from_list NUMERIC Unsubscribed From List (duplicate) Unsubscribed from list
unsubscribed_rate NUMERIC Unsubscribed Rate From List Unsubscribed from list Rate
unsubscribed_rate_from_list NUMERIC Unsubscribed Rate From List (duplicate) Unsubscribed from list Rate
viewed_product NUMERIC Viewed Product Total number of Viewed Product events

Klaviyo other fields

The Klaviyo connector has 41 fields that do not belong to a named report, or belong to a report with only one or two fields.

Klaviyo other fields (campaign_report_conversion_metric_active_on_site to year_week)

ID Type Name Description Report
campaign_report_conversion_metric_active_on_site TEXT Campaign Report Conversion Metric Active on Site Campaign Report Conversion Metric Active on Site
campaign_report_conversion_metric_bounced_email TEXT Campaign Report Conversion Metric Bounced Email Campaign Report Conversion Metric Bounced Email
campaign_report_conversion_metric_clicked_email TEXT Campaign Report Conversion Metric Clicked Email Campaign Report Conversion Metric Clicked Email
campaign_report_conversion_metric_clicked_sms TEXT Campaign Report Conversion Metric Clicked SMS Campaign Report Conversion Metric Clicked SMS
campaign_report_conversion_metric_dropped_email TEXT Campaign Report Conversion Metric Dropped Email Campaign Report Conversion Metric Dropped Email
campaign_report_conversion_metric_failed_to_deliver_sms TEXT Campaign Report Conversion Metric Failed to Deliver SMS Campaign Report Conversion Metric Failed to Deliver SMS
campaign_report_conversion_metric_marked_email_as_spam TEXT Campaign Report Conversion Metric Marked Email as Spam Campaign Report Conversion Metric Marked Email as Spam
campaign_report_conversion_metric_opened_email TEXT Campaign Report Conversion Metric Opened Email Campaign Report Conversion Metric Opened Email
campaign_report_conversion_metric_received_email TEXT Campaign Report Conversion Metric Received Email Campaign Report Conversion Metric Received Email
campaign_report_conversion_metric_sent_sms TEXT Campaign Report Conversion Metric Sent SMS Campaign Report Conversion Metric Sent SMS
campaign_report_conversion_metric_subscribed_to_list TEXT Campaign Report Conversion Metric Subscribed to List Campaign Report Conversion Metric Subscribed to List
campaign_report_conversion_metric_unsubscribe_page_submit TEXT Campaign Report Conversion Metric Unsubscribe Page Submit Campaign Report Conversion Metric Unsubscribe Page Submit
campaign_report_conversion_metric_unsubscribed TEXT Campaign Report Conversion Metric Unsubscribed Campaign Report Conversion Metric Unsubscribed
campaign_report_conversion_metric_unsubscribed_from_list TEXT Campaign Report Conversion Metric Unsubscribed from List Campaign Report Conversion Metric Unsubscribed from List
data_fetched_at TIMESTAMP Data fetched at UTC timestamp (second precision) of when the connector request that pulled the row started. Freshly pulled rows show this request's start time; cache hits keep the start time of the request that filled the cache. Selecting this field disables aggregation, so rows are returned individually (each keeping its own fetch time) instead of being summed.
datasource TEXT Data Source The name of the Windsor connector returning the row
day_of_month TEXT Day of month Day of the month
flow_conversion_metric_active_on_site TEXT Flow Conversion Metric Active on Site Active on Site - to be used for conversion metrics in flows stats
flow_conversion_metric_bounced_email TEXT Flow Conversion Metric Bounced Email Bounced Email - to be used for conversion metrics in flows stats
flow_conversion_metric_clicked_email TEXT Flow Conversion Metric Clicked Email Clicked Email - to be used for conversion metrics in flows stats
flow_conversion_metric_clicked_sms TEXT Flow Conversion Metric Clicked SMS Clicked SMS - to be used for conversion metrics in flows stats
flow_conversion_metric_opened_email TEXT Flow Conversion Metric Opened Email Opened Email - to be used for conversion metrics in flows stats
flow_conversion_metric_received_sms TEXT Flow Conversion Metric Received SMS Received SMS - to be used for conversion metrics in flows stats
flow_conversion_metric_sent_sms TEXT Flow Conversion Metric Sent SMS Sent SMS - to be used for conversion metrics in flows stats
flow_conversion_metric_subscribed_to_list TEXT Flow Conversion Metric Subscribed to List Subscribed to List - to be used for conversion metrics in flows stats
flow_conversion_metric_unsubscribed TEXT Flow Conversion Metric Unsubscribed Unsubscribed - to be used for conversion metrics in flows stats
month TEXT Month Number of the month
now TIMESTAMP Now Current timestamp
source TEXT Source The name of the Windsor connector returning the row
today DATE Today Today's date
week TEXT Week Week (Sun-Sat).
week_day TEXT Day of week and day number Weekday number and name combined (Sun-Sat).Numbered from 0 Sunday to 6 Saturday.
week_day_iso TEXT Day of week and day number, ISO Weekday number and name combined, ISO format (Mon-Sun).Numbered from 1 Monday to 7
week_iso TEXT Week ISO Week, ISO format (Mon-Sun).
year TEXT Year Year
year_month TEXT Yearmonth Year and month, e.g. 2024|3
year_month_name TEXT Year month name Year and month with the month name written out, e.g. "Jan 2025".
year_of_week TEXT Year of week The year that contains first day of the week (Sun-Sat).
year_of_week_iso TEXT Year of week, ISO The year that contains first day of the ISO week (Mon-Sun).
year_week TEXT Year week Year and week for US weeks (Sun-Sat), e.g. 2024|15

Klaviyo other fields (year_week_iso to year_week_iso)

ID Type Name Description Report
year_week_iso TEXT Year week ISO Year and week for ISO weeks (Mon-Sun), e.g. 2024|20