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.

IDTypeNameDescription
campaign_report_average_order_valueNUMERICCampaign report Average Order ValueCampaign report Average Order Value
campaign_report_bounce_ratePERCENTCampaign report Bounce RateCampaign report Bounce Rate
campaign_report_bouncedNUMERICCampaign report BouncedCampaign report Bounced
campaign_report_bounced_or_failedNUMERICCampaign report Bounced Or FailedCampaign report Bounced Or Failed
campaign_report_bounced_or_failed_ratePERCENTCampaign report Bounced Or Failed RateCampaign report Bounced Or Failed Rate
campaign_report_click_ratePERCENTCampaign report Click RateCampaign report Click Rate
campaign_report_click_to_open_ratePERCENTCampaign report Click To Open RateCampaign report Click To Open Rate
campaign_report_clicksNUMERICCampaign report ClicksCampaign report Clicks
campaign_report_clicks_uniqueNUMERICCampaign report Clicks UniqueCampaign report Clicks Unique
campaign_report_conversion_ratePERCENTCampaign report Conversion RateCampaign report Conversion Rate
campaign_report_conversion_uniquesNUMERICCampaign report Conversion UniquesCampaign report Conversion Uniques
campaign_report_conversion_valueNUMERICCampaign report Conversion ValueCampaign report Conversion Value
campaign_report_conversionsNUMERICCampaign report ConversionsCampaign report Conversions
campaign_report_deliveredNUMERICCampaign report DeliveredCampaign report Delivered
campaign_report_delivery_ratePERCENTCampaign report Delivery RateCampaign report Delivery Rate
campaign_report_failedNUMERICCampaign report FailedCampaign report Failed
campaign_report_failed_ratePERCENTCampaign report Failed RateCampaign report Failed Rate
campaign_report_open_ratePERCENTCampaign report Open RateCampaign report Open Rate
campaign_report_opensNUMERICCampaign report OpensCampaign report Opens
campaign_report_opens_uniqueNUMERICCampaign report Opens UniqueCampaign report Opens Unique
campaign_report_recipientsNUMERICCampaign report RecipientsCampaign report Recipients
campaign_report_revenue_per_recipientNUMERICCampaign report Revenue Per RecipientCampaign report Revenue Per Recipient
campaign_report_spam_complaint_ratePERCENTCampaign report Spam Complaint RateCampaign report Spam Complaint Rate
campaign_report_spam_complaintsNUMERICCampaign report Spam ComplaintsCampaign report Spam Complaints
campaign_report_unsubscribe_ratePERCENTCampaign report Unsubscribe RateCampaign report Unsubscribe Rate
campaign_report_unsubscribe_uniquesNUMERICCampaign report Unsubscribe UniquesCampaign report Unsubscribe Uniques
campaign_report_unsubscribesNUMERICCampaign report UnsubscribesCampaign report Unsubscribes

Klaviyo campaigns fields

The campaigns report of the Klaviyo connector includes 11 fields.

IDTypeNameDescription
campaignTEXTCampaign NameCampaign name
campaign_channelTEXTCampaign ChannelCampaign Channel
campaign_idTEXTCampaign IDCampaign id
createdTEXTCampaign Created atCampaign creation time
from_emailTEXTFrom E-mailFrom e-mail
from_nameTEXTFrom NameFrom name
message_channelTEXTMessage ChannelMessage Channel
sent_atTEXTSent atCampaign sent time
statusTEXTStatusCampaign status
subjectTEXTSubjectCampaign subject
subscription_statusTEXTSubscription statusEmail subscriptions status

Klaviyo events fields

The events report of the Klaviyo connector includes 12 fields.

IDTypeNameDescription
card_last_fourTEXTCard Last FourLast four digits of the card used for the payment, from Stripe Successful Payment and Failed Payment events
card_typeTEXTCard TypeCard brand used for the payment (e.g. visa, mastercard), from Stripe Successful Payment and Failed Payment events
event_datetimeTEXTEvent DatetimeTime the event occurred, in ISO8601 format
event_nameTEXTEvent NameName of the metric the event was tracked for
event_uuidTEXTEvent UUIDKlaviyo's unique identifier of the event
order_idTEXTOrder IDIdentifier of the order the event belongs to, for events tracked by an ecommerce or shipping integration
payment_failure_reasonTEXTPayment Failure ReasonReason a payment failed (e.g. card declined), from Stripe Failed Payment events
profile_emailTEXTProfile EmailEmail address of the profile the event is associated with
profile_firstnameTEXTProfile First NameFirst name of the profile the event is associated with
profile_idTEXTProfile IDKlaviyo profile/member id the event is associated with; joins with the Members table 'id' field
profile_lastnameTEXTProfile Last NameLast name of the profile the event is associated with
refund_amountNUMERICRefund AmountAmount refunded, from Stripe Refunded Payment events

Klaviyo flows fields

The flows report of the Klaviyo connector includes 37 fields.

IDTypeNameDescription
flow_archivedTEXTFlow ArchivedFlow Archived
flow_average_order_valueNUMERICFlow Average order valueFlow Average order value
flow_bounce_ratePERCENTFlow Bounce rateFlow Bounce rate
flow_bouncedNUMERICFlow BouncedFlow Bounced
flow_bounced_or_failedNUMERICFlow Bounced or failedFlow Bounced or failed
flow_bounced_or_failed_ratePERCENTFlow Bounced or failed rateFlow Bounced or failed rate
flow_click_ratePERCENTFlow Click rateFlow Click rate
flow_click_to_open_ratePERCENTFlow Click to open rateFlow Click to open rate
flow_clicksNUMERICFlow ClicksFlow Clicks
flow_clicks_uniqueNUMERICFlow Clicks uniqueFlow Clicks unique
flow_conversion_ratePERCENTFlow Conversion rateFlow Conversion rate
flow_conversion_uniquesNUMERICFlow Conversion uniquesFlow Conversion uniques
flow_conversion_valueNUMERICFlow Conversion valueFlow Conversion value
flow_conversionsNUMERICFlow ConversionsFlow Conversions
flow_created_timeTIMESTAMPFlow Created TimeFlow Created Time
flow_deliveredNUMERICFlow DeliveredFlow Delivered
flow_delivery_ratePERCENTFlow Delivery rateFlow Delivery rate
flow_failedNUMERICFlow FailedFlow Failed
flow_failed_ratePERCENTFlow Failed rateFlow Failed rate
flow_idTEXTFlow IDFlow ID
flow_message_idTEXTFlow Message IDFlow Message ID
flow_message_nameTEXTFlow Message NameFlow Message Name
flow_nameTEXTFlow NameFlow Name
flow_open_ratePERCENTFlow Open rateFlow Open rate
flow_opensNUMERICFlow OpensFlow Opens
flow_opens_uniqueNUMERICFlow Opens uniqueFlow Opens unique
flow_recipientsNUMERICFlow RecipientsFlow Recipients
flow_revenue_per_recipientNUMERICFlow Revenue per recipientFlow Revenue per recipient
flow_spam_complaint_ratePERCENTFlow Spam complaint rateFlow Spam complaint rate
flow_spam_complaintsNUMERICFlow Spam complaintsFlow Spam complaints
flow_statusTEXTFlow StatusFlow Status
flow_trigger_typeTEXTFlow Trigger TypeFlow Trigger Type
flow_unsubscribe_ratePERCENTFlow Unsubscribe rateFlow Unsubscribe rate
flow_unsubscribe_uniquesNUMERICFlow Unsubscribe uniquesFlow Unsubscribe uniques
flow_unsubscribesNUMERICFlow UnsubscribesFlow Unsubscribes
flow_updated_timeTIMESTAMPFlow Updated TimeFlow Updated Time
flow_urlTEXTFlow URLFlow Url

Klaviyo general fields

The general report of the Klaviyo connector includes 3 fields.

IDTypeNameDescription
account_idTEXTAccount IDKlaviyo account ID
account_nameTEXTAccount NameKlaviyo account name
dateDATEDateDate of metric type data

Klaviyo members fields

The members report of the Klaviyo connector includes 32 fields.

IDTypeNameDescription
address1TEXTAddress Line 1The primary address line of the object
address2TEXTAddress Line 2The secondary address line of the object
cityCITYCityThe city of the object
countryCOUNTRYCountryThe country of the object
created_atDATECreated Date/TimeThe date and time the object was created
dimension_member_countNUMERICMember CountMember count for current dimension values
emailTEXTEmail addressThe email address of the object
firstnameTEXTFirst NameThe first name of the object
idTEXTIDThe ID of the object
lastnameTEXTLast NameThe last name of the object
latitudeTEXTLatitudeThe latitude of the object
list_createdTIMESTAMPList Create DateList Create Date
list_idTEXTList IdList Id
list_nameTEXTList NameList Name
list_profile_countNUMERICList Profile CountTotal number of profiles in the list
list_updatedTIMESTAMPList Update DateList Update Date
localeTEXTLocaleThe locale of the profile
longitudeTEXTLongitudeThe longitude of the object
members_countNUMERICAccount Member CountTotal number of members for the whole account
objectTEXTObject TypeThe type of the object (e.g. Person)
organization_nameTEXTOrganization NameThe organization of the object
phoneTEXTPhone NumberThe phone number of the object
regionREGIONRegionThe region of the object
segment_createdTIMESTAMPSegment Create DateSegment Create Date
segment_idTEXTSegment IdSegment Id
segment_nameTEXTSegment NameSegment Name
segment_profile_countNUMERICSegment Profile CountTotal number of profiles in the segment
segment_updatedTIMESTAMPSegment Update DateSegment Update Date
timezoneTEXTTime ZoneThe time zone of the object
titleTEXTTitleThe title of the object
updated_atDATEUpdated Date/TimeThe date and time the object was last updated
zipTEXTZIP CodeThe 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)

IDTypeNameDescription
added_to_cartNUMERICAdded to CartTotal number of Added to Cart events
bounced_emailNUMERICBounced EmailBounced Email
bounced_email_rateNUMERICBounced Email RateBounced Email Rate
cancelled_orderNUMERICCancelled OrderTotal amount of Cancelled Order
cancelled_order_valueNUMERICCancelled Order ValueCancelled Order value
checkout_completedNUMERICCheckout CompletedCheckout Completed
checkout_start_to_order_rateNUMERICCheckout Start to Order RateCompleted checkouts as ratio of checkout starts
checkout_startedNUMERICCheckout StartedTotal amount of Checkout Started
checkout_started_valueNUMERICCheckout Started ValueCheckout Started value
click_ratePERCENTClick rateClick rate of e-mails
clicked_smsNUMERICUnique Clicked SMSNumber of unique SMS clicks
clicksNUMERICClicksNumber of unique e-mail clicks
conversionsNUMERICConversionsTotal Value of placed orders
conversions_avg_valuePERCENTAverage Conversion ValueAverage value of placed orders
dimensionsTEXTFlow dimensionsFlow dimensions
failed_to_deliver_smsNUMERICFailed To Deliver SMSNumber of SMS messages that failed to deliver
fulfilled_orderNUMERICFulfilled OrderTotal amount of Fulfilled Order
fulfilled_order_valueNUMERICFulfilled Order ValueFulfilled Order value
fulfilled_partial_orderNUMERICFulfilled Partial OrderTotal amount of Fulfilled Partial Order
fulfilled_partial_order_valueNUMERICFulfilled Partial Order ValueFulfilled Order value
open_ratePERCENTOpen rateOpen rate of E-mails
opensNUMERICOpensNumber of unique e-mail opens
ordered_productNUMERICOrdered ProductTotal amount of Ordered product
ordered_product_avg_valuePERCENTOrdered Product Average ValueOrdered product average value
ordered_product_valueNUMERICOrdered Product ValueOrdered product value
received_emailsNUMERICReceived e-mailsNumber of e-mails received
received_smsNUMERICReceived SMSNumber of unique SMS messages received
refunded_orderNUMERICRefunded OrderTotal amount of Refunded Order
refunded_order_valueNUMERICRefunded Order ValueRefunded Order value
revenueNUMERICRevenueTotal Value of placed orders
revenue_per_recipientNUMERICRevenue per RecipientThe amount of revenue attributed to a campaign divided by the number of recipients
sent_emailsNUMERICSent EmailsThe number of recipients the email was sent to
sent_smsNUMERICSent SMSNumber of SMS messages sent
shopify_cancelled_orderNUMERICShopify Cancelled OrderThis event is tracked when a customer creates an order in your Shopify store but then cancels the order before fulfillment
shopify_checkout_startedNUMERICShopify Checkout StartedShopify checkout completed
shopify_confirmed_shipmentNUMERICShopify Confirmed ShipmentShopify Confirmed Shipment
shopify_delivered_shipmentNUMERICShopify Delivered ShipmentShopify Delivered Shipment
shopify_fulfilled_orderNUMERICShopify Fulfilled OrderThis event is tracked when an order is marked as 'fulfilled' in your Shopify store
shopify_fulfilled_partial_orderNUMERICShopify Fulfilled Partial OrderThis event is tracked when an order is marked as 'fulfilled' in your Shopify store
shopify_marked_out_for_deliveryNUMERICShopify Marked Out for DeliveryShopify Marked Out for Delivery

Klaviyo metrics fields (shopify_ordered_product to viewed_product)

IDTypeNameDescription
shopify_ordered_productNUMERICShopify Ordered ProductThe total quantity ordered of the product
shopify_placed_orderNUMERICShopify Placed OrderThis event is tracked when a customer completes the checkout process and creates an order in your Shopify store
shopify_refunded_orderNUMERICShopify Refunded OrderThis 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_revenueNUMERICShopify RevenueRevenue value from Shopify Placed Order events.
sms_click_ratePERCENTSMS Click RateUnique SMS clicks divided by SMS received
sms_unsubscribesNUMERICUnsubscribed From SMSNumber of SMS marketing unsubscribes
subscribedNUMERICSubscribed to ListSubscribed to List
total_clicked_smsNUMERICTotal Clicked SMSTotal number of SMS clicks
total_clicksNUMERICTotal ClicksTotal number of e-mail clicks
total_conversionsNUMERICTotal ConversionsTotal amount of placed orders
total_opensNUMERICTotal OpensTotal number of e-mail opens
unsubscribedNUMERICUnsubscribed From ListUnsubscribed from list
unsubscribed_from_listNUMERICUnsubscribed From List (duplicate)Unsubscribed from list
unsubscribed_rateNUMERICUnsubscribed Rate From ListUnsubscribed from list Rate
unsubscribed_rate_from_listNUMERICUnsubscribed Rate From List (duplicate)Unsubscribed from list Rate
viewed_productNUMERICViewed ProductTotal 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)

IDTypeNameDescriptionReport
campaign_report_conversion_metric_active_on_siteTEXTCampaign Report Conversion Metric Active on SiteCampaign Report Conversion Metric Active on Site
campaign_report_conversion_metric_bounced_emailTEXTCampaign Report Conversion Metric Bounced EmailCampaign Report Conversion Metric Bounced Email
campaign_report_conversion_metric_clicked_emailTEXTCampaign Report Conversion Metric Clicked EmailCampaign Report Conversion Metric Clicked Email
campaign_report_conversion_metric_clicked_smsTEXTCampaign Report Conversion Metric Clicked SMSCampaign Report Conversion Metric Clicked SMS
campaign_report_conversion_metric_dropped_emailTEXTCampaign Report Conversion Metric Dropped EmailCampaign Report Conversion Metric Dropped Email
campaign_report_conversion_metric_failed_to_deliver_smsTEXTCampaign Report Conversion Metric Failed to Deliver SMSCampaign Report Conversion Metric Failed to Deliver SMS
campaign_report_conversion_metric_marked_email_as_spamTEXTCampaign Report Conversion Metric Marked Email as SpamCampaign Report Conversion Metric Marked Email as Spam
campaign_report_conversion_metric_opened_emailTEXTCampaign Report Conversion Metric Opened EmailCampaign Report Conversion Metric Opened Email
campaign_report_conversion_metric_received_emailTEXTCampaign Report Conversion Metric Received EmailCampaign Report Conversion Metric Received Email
campaign_report_conversion_metric_sent_smsTEXTCampaign Report Conversion Metric Sent SMSCampaign Report Conversion Metric Sent SMS
campaign_report_conversion_metric_subscribed_to_listTEXTCampaign Report Conversion Metric Subscribed to ListCampaign Report Conversion Metric Subscribed to List
campaign_report_conversion_metric_unsubscribe_page_submitTEXTCampaign Report Conversion Metric Unsubscribe Page SubmitCampaign Report Conversion Metric Unsubscribe Page Submit
campaign_report_conversion_metric_unsubscribedTEXTCampaign Report Conversion Metric UnsubscribedCampaign Report Conversion Metric Unsubscribed
campaign_report_conversion_metric_unsubscribed_from_listTEXTCampaign Report Conversion Metric Unsubscribed from ListCampaign Report Conversion Metric Unsubscribed from List
data_fetched_atTIMESTAMPData fetched atUTC 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.
datasourceTEXTData SourceThe name of the Windsor connector returning the row
day_of_monthTEXTDay of monthDay of the month
flow_conversion_metric_active_on_siteTEXTFlow Conversion Metric Active on SiteActive on Site - to be used for conversion metrics in flows stats
flow_conversion_metric_bounced_emailTEXTFlow Conversion Metric Bounced EmailBounced Email - to be used for conversion metrics in flows stats
flow_conversion_metric_clicked_emailTEXTFlow Conversion Metric Clicked EmailClicked Email - to be used for conversion metrics in flows stats
flow_conversion_metric_clicked_smsTEXTFlow Conversion Metric Clicked SMSClicked SMS - to be used for conversion metrics in flows stats
flow_conversion_metric_opened_emailTEXTFlow Conversion Metric Opened EmailOpened Email - to be used for conversion metrics in flows stats
flow_conversion_metric_received_smsTEXTFlow Conversion Metric Received SMSReceived SMS - to be used for conversion metrics in flows stats
flow_conversion_metric_sent_smsTEXTFlow Conversion Metric Sent SMSSent SMS - to be used for conversion metrics in flows stats
flow_conversion_metric_subscribed_to_listTEXTFlow Conversion Metric Subscribed to ListSubscribed to List - to be used for conversion metrics in flows stats
flow_conversion_metric_unsubscribedTEXTFlow Conversion Metric UnsubscribedUnsubscribed - to be used for conversion metrics in flows stats
monthTEXTMonthNumber of the month
nowTIMESTAMPNowCurrent timestamp
sourceTEXTSourceThe name of the Windsor connector returning the row
todayDATETodayToday's date
weekTEXTWeekWeek (Sun-Sat).
week_dayTEXTDay of week and day numberWeekday number and name combined (Sun-Sat).Numbered from 0 Sunday to 6 Saturday.
week_day_isoTEXTDay of week and day number, ISOWeekday number and name combined, ISO format (Mon-Sun).Numbered from 1 Monday to 7
week_isoTEXTWeek ISOWeek, ISO format (Mon-Sun).
yearTEXTYearYear
year_monthTEXTYearmonthYear and month, e.g. 2024|3
year_month_nameTEXTYear month nameYear and month with the month name written out, e.g. "Jan 2025".
year_of_weekTEXTYear of weekThe year that contains first day of the week (Sun-Sat).
year_of_week_isoTEXTYear of week, ISOThe year that contains first day of the ISO week (Mon-Sun).
year_weekTEXTYear weekYear and week for US weeks (Sun-Sat), e.g. 2024|15

Klaviyo other fields (year_week_iso to year_week_iso)

IDTypeNameDescriptionReport
year_week_isoTEXTYear week ISOYear and week for ISO weeks (Mon-Sun), e.g. 2024|20