Explore the Klaviyo API data model

Pulling data from the Klaviyo API is only the first part of your reporting. You also need to understand the relationships between different endpoints - something that APIs typically fail to convey.

At SyncHub, we not only sync your Klaviyo API endpoints down into a reportable format, we also describe their relationships (e.g. in terms of foreign keys) so that you can quickly get a grasp of your data and how it fits together. This page is intended as technical documentation of these relationships.

Campaign

Documentation: https://developers.klaviyo.com/en/reference/get_campaigns

Column	Type	Relates to	Notes
RemoteID	string	-	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
ID	string	-	-
Name	string	-	-
CreatedAt	datetime	-	-
UpdatedAt	datetime	-	-
Archived	boolean	-	-
Status	string	-	-
ScheduledAt	datetime	-	-
SendTime	datetime	-	-
UseSmartSending	boolean	-	-
IgnoreUnsubscribes	boolean	-	-
SendStrategyMethod	string	-	-
SendStrategyDatetime	datetime	-	-
SendStrategySendPastRecipientsImmediately	boolean	-	-
CampaignChannelType	string	-	-
Type	string	-	-

CatalogCategory

Documentation: https://developers.klaviyo.com/en/reference/get_catalog_categories

Column	Type	Relates to	Notes
RemoteID	string	-	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
ID	string	-	-
Name	string	-	-
ExternalID	string	-	-
Updated	datetime	-	-
Type	string	-	-

CatalogItem

Documentation: https://developers.klaviyo.com/en/reference/get_catalog_items

Column	Type	Relates to	Notes
RemoteID	string	-	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
ID	string	-	-
Description	string	-	-
ExternalID	string	-	-
Created	datetime	-	-
Updated	datetime	-	-
Published	boolean	-	-
Title	string	-	-
CatalogType	string	-	-
IntegrationType	string	-	-
ImageFullUrl	string	-	-
ImageThumbnailUrl	string	-	-
Url	string	-	-
Price	decimal	-	-
CustomMetaData	string	-	-
SelfPageURL	string	-	-
Type	string	-	-

Event

Documentation: https://developers.klaviyo.com/en/reference/get_event

Column	Type	Relates to	Notes
RemoteID	string	-	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
ID	string	-	-
Timestamp	int	-	-
Datetime	datetime	-	-
Uuid	guid	-	-
ProfileID	string	Profile → ID	-
MetricID	string	Metric → ID	-
Type	string	-	-

Flow

Documentation: https://developers.klaviyo.com/en/reference/flows_api_overview

Column	Type	Relates to	Notes
RemoteID	string	-	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
ID	string	-	-
Name	string	-	-
ExternalID	string	-	-
Updated	datetime	-	-
Created	datetime	-	-
Archived	boolean	-	-
TriggerType	string	-	-
Type	string	-	-

Image

Documentation: https://developers.klaviyo.com/en/reference/get_images

Column	Type	Relates to	Notes
RemoteID	string	-	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
ID	string	-	-
Name	string	-	-
UpdatedAt	datetime	-	-
ImageUrl	string	-	-
Format	string	-	-
Size	long	-	-
Hidden	boolean	-	-
Type	string	-	-

List

Documentation: https://developers.klaviyo.com/en/reference/get_lists

Column	Type	Relates to	Notes
RemoteID	string	-	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
ID	string	-	-
Name	string	-	-
ExternalID	string	-	-
Updated	datetime	-	-
Created	datetime	-	-
OptInProcess	string	-	-
Type	string	-	-

Metric

Documentation: https://developers.klaviyo.com/en/reference/get_metrics

Column	Type	Relates to	Notes
RemoteID	string	-	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
ID	string	-	-
Name	string	-	-
Created	datetime	-	-
Updated	datetime	-	-
IntegrationID	string	-	-
IntegrationName	string	-	-
IntegrationCategory	string	-	-
IntegrationObject	string	-	-
IntegrationKey	string	-	-
Type	string	-	-

Profile

Documentation: https://developers.klaviyo.com/en/reference/get_profiles

Column	Type	Relates to	Notes
RemoteID	string	-	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
ID	string	-	-
Email	string	-	-
Updated	datetime	-	-
Created	datetime	-	-
LastEventDate	datetime	-	-
FirstName	string	-	-
LastName	string	-	-
PhoneNumber	string	-	-
ExternalID	string	-	-
Organization	string	-	-
Locale	string	-	-
Image	string	-	-
Title	string	-	-
Address1	string	-	-
Address2	string	-	-
City	string	-	-
Country	string	-	-
Latitude	string	-	-
Longitude	string	-	-
Region	string	-	-
Zip	string	-	-
Timezone	string	-	-
Ip	string	-	-
HistoricClv	decimal	-	-
PredictedClv	decimal	-	-
TotalClv	decimal	-	-
HistoricNumberOfOrders	decimal	-	-
PredictedNumberOfOrders	decimal	-	-
AverageDaysBetweenOrders	decimal	-	-
AverageOrderValue	decimal	-	-
ChurnProbability	decimal	-	-
ExpectedDateOfNextOrder	datetime	-	-
Type	string	-	-

Review

Documentation: https://developers.klaviyo.com/en/reference/get_reviews

Column	Type	Relates to	Notes
RemoteID	string	-	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
ID	string	-	-
Email	string	-	-
StatusValue	string	-	-
StatusRejectionReason	string	-	-
StatusRejectionExplanation	string	-	-
Created	datetime	-	-
Updated	datetime	-	-
Verified	boolean	-	-
ReviewType	string	-	-
Rating	int	-	-
Author	string	-	-
Content	string	-	-
Title	string	-	-
SmartQuote	string	-	-
PublicReplyContent	string	-	-
PublicReplyAuthor	string	-	-
PublicReplyUpdated	datetime	-	-
ProductUrl	string	-	-
ProductName	string	-	-
ProductImageUrl	string	-	-
ProductExternalID	string	-	-
Type	string	-	-

Segment

Documentation: https://developers.klaviyo.com/en/reference/get_segments

Column	Type	Relates to	Notes
RemoteID	string	-	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
ID	string	-	-
Name	string	-	-
Updated	datetime	-	-
Created	datetime	-	-
IsActive	boolean	-	-
IsStarred	boolean	-	-
IsProcessing	boolean	-	-
Type	string	-	-

Tag

Documentation: https://developers.klaviyo.com/en/reference/get_tags

Column	Type	Relates to	Notes
RemoteID	string	-	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
ID	string	-	-
Name	string	-	-
Type	string	-	-

TagGroup

Documentation: https://developers.klaviyo.com/en/reference/get_tag_groups

Column	Type	Relates to	Notes
RemoteID	string	-	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
ID	string	-	-
Name	string	-	-
Exclusive	boolean	-	-
Default	boolean	-	-
Type	string	-	-

CampaignTag

Column	Type	Relates to	Notes
RemoteID	string	-	-
CampaignRemoteID	string	Campaign → RemoteID	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
TagID	string	Tag → ID	-
CampaignID	string	Campaign → ID	-

CampaignMessage

Column	Type	Relates to	Notes
RemoteID	string	-	-
CampaignRemoteID	string	Campaign → RemoteID	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
ID	string	-	-
CampaignID	string	Campaign → ID	-
CreatedAt	datetime	-	-
UpdatedAt	datetime	-	-
Channel	string	-	-
Label	string	-	-
Subject	string	-	-
PreviewText	string	-	-
FromEmail	string	-	-
FromLabel	string	-	-
ReplyToEmail	string	-	-
BccEmail	string	-	-
CcEmail	string	-	-
Type	string	-	-

CatalogItemImage

Column	Type	Relates to	Notes
RemoteID	string	-	-
CatalogItemRemoteID	string	CatalogItem → RemoteID	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
CatalogItemID	string	CatalogItem → ID	-
CatalogItemImageURL	string	-	-

CatalogItemVariant

Documentation: https://developers.klaviyo.com/en/reference/get_catalog_variants

Column	Type	Relates to	Notes
RemoteID	string	-	-
CatalogItemRemoteID	string	CatalogItem → RemoteID	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
ID	string	-	-
Description	string	-	-
CatalogItemID	string	CatalogItem → ID	-
ExternalID	string	-	-
Created	datetime	-	-
Updated	datetime	-	-
Published	boolean	-	-
Title	string	-	-
ImageFullUrl	string	-	-
ImageThumbnailUrl	string	-	-
Url	string	-	-
Price	decimal	-	-
InventoryPolicy	int	-	-
InventoryQuantity	decimal	-	-
CustomMetaData	string	-	-
Type	string	-	-

EventPropertyValue

Column	Type	Relates to	Notes
RemoteID	string	-	-
EventRemoteID	string	Event → RemoteID	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
EventID	string	Event → ID	-
MetricPropertyExternalReferenceID	string	MetricProperty → ExternalReferenceID	-
PropertyName	string	-	-
MetricID	string	Metric → ID	-
Value	string	-	-

FlowAction

Documentation: https://developers.klaviyo.com/en/reference/get_flow_action

Column	Type	Relates to	Notes
RemoteID	string	-	-
FlowRemoteID	string	Flow → RemoteID	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
ID	string	-	-
FlowID	string	Flow → ID	-
ActionType	string	-	-
Status	string	-	-
Created	datetime	-	-
Updated	datetime	-	-
AddUtm	boolean	-	-
IsTrackingOpens	boolean	-	-
IsTrackingClicks	boolean	-	-
UseSmartSending	boolean	-	-
IsTransactional	boolean	-	-
ShortenLinks	boolean	-	-
AddOrgPrefix	boolean	-	-
AddInfoLink	boolean	-	-
AddOptOutLanguage	boolean	-	-
Type	string	-	-

ListTag

Column	Type	Relates to	Notes
RemoteID	string	-	-
ListRemoteID	string	List → RemoteID	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
ListID	string	List → ID	-
TagID	string	Tag → ID	-

ListMember

Column	Type	Relates to	Notes
RemoteID	string	-	-
ListRemoteID	string	List → RemoteID	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
ListID	string	List → ID	-
ProfileID	string	Profile → ID	-

MetricFlowTrigger

Column	Type	Relates to	Notes
RemoteID	string	-	-
MetricRemoteID	string	Metric → RemoteID	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
ID	string	Flow → ID	-
MetricID	string	Metric → ID	-

MetricProperty

Column	Type	Relates to	Notes
RemoteID	string	-	-
MetricRemoteID	string	Metric → RemoteID	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
ID	string	-	-
MetricID	string	Metric → ID	-
Label	string	-	-
Property	string	-	-
InferredType	string	-	-
ExternalReferenceID	string	-	-
Type	string	-	-

ProfileRankedChannelAffinity

Column	Type	Relates to	Notes
RemoteID	string	-	-
ProfileRemoteID	string	Profile → RemoteID	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
ProfileID	string	Profile → ID	-
ChannelName	string	-	-
Rank	int	-	-

ReviewImage

Column	Type	Relates to	Notes
RemoteID	string	-	-
ReviewRemoteID	string	Review → RemoteID	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
ReviewID	string	Review → ID	-
ReviewImageURL	string	-	-

ReviewEvent

Column	Type	Relates to	Notes
RemoteID	string	-	-
ReviewRemoteID	string	Review → RemoteID	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
ReviewID	string	Review → ID	-
EventID	string	Event → ID	-

SegmentConditionGroup

Column	Type	Relates to	Notes
RemoteID	string	-	-
SegmentRemoteID	string	Segment → RemoteID	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
SegmentID	string	Segment → ID	-
Iterator	int	-	-

TagGroupMembership

Documentation: https://developers.klaviyo.com/en/reference/get_tags

Column	Type	Relates to	Notes
RemoteID	string	-	-
TagRemoteID	string	Tag → RemoteID	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
TagID	string	Tag → ID	-
TagGroupID	string	TagGroup → ID	-

CatalogItemVariantImage

Column	Type	Relates to	Notes
RemoteID	string	-	-
CatalogItemVariantRemoteID	string	CatalogItemVariant → RemoteID	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
CatalogItemVariantID	string	CatalogItemVariant → ID	-
Url	string	-	-

FlowActionMessage

Documentation: https://developers.klaviyo.com/en/reference/get_flow_action_messages

Column	Type	Relates to	Notes
RemoteID	string	-	-
FlowActionRemoteID	string	FlowAction → RemoteID	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
ID	string	-	-
Name	string	-	-
FlowActionID	string	FlowAction → ID	-
Channel	boolean	-	-
Created	datetime	-	-
Updated	datetime	-	-
Subject	string	-	-
PreviewText	string	-	-
FromEmail	string	-	-
FromLabel	string	-	-
ReplyToEmail	string	-	-
CcEmail	string	-	-
BccEmail	string	-	-
Type	string	-	-

FlowActionUTMParam

Column	Type	Relates to	Notes
RemoteID	string	-	-
FlowActionRemoteID	string	FlowAction → RemoteID	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
Name	string	-	-
FlowActionID	string	FlowAction → ID	-
Value	string	-	-

SegmentCondition

Column	Type	Relates to	Notes
RemoteID	string	-	-
SegmentConditionGroupRemoteID	string	SegmentConditionGroup → RemoteID	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
ConditionGroupID	int	SegmentConditionGroup → Iterator	-
Type	string	-	-
Iterator	int	-	-
IsMember	string	-	-
Measurement	string	-	-
MetricID	string	Metric → ID	-
CountryCode	string	-	-
PostalCode	string	-	-
Unit	string	-	-
Dimension	string	-	-
PredictedChannel	string	-	-
Region	string	-	-
InRegion	boolean	-	-

SegmentConditionGroupMembership

Column	Type	Relates to	Notes
RemoteID	string	-	-
SegmentConditionRemoteID	string	SegmentCondition → RemoteID	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
GroupID	string	-	-
ConditionID	string	SegmentCondition → RemoteID	-
Iterator	int	-	-

SegmentConditionFilter

Column	Type	Relates to	Notes
RemoteID	string	-	-
SegmentConditionRemoteID	string	SegmentCondition → RemoteID	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
ConditionID	string	SegmentCondition → RemoteID	-
Iterator	int	-	-
Property	string	-	-
Type	string	-	-
Operator	string	-	-
Unit	string	-	-
PredictedChannel	string	-	-
Date	datetime	-	-
StartDate	datetime	-	-
EndDate	datetime	-	-
StartDateInt	int	-	-
EndDateInt	int	-	-
Value	string	-	-
Quantity	decimal	-	-

SegmentConditionMarketingConsent

Column	Type	Relates to	Notes
RemoteID	string	-	-
SegmentConditionRemoteID	string	SegmentCondition → RemoteID	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
Subscription	string	-	-
CanReceiveMarketing	string	-	-
Channel	string	-	-
ConditionID	string	SegmentCondition → RemoteID	-
Iterator	int	-	-

SegmentConditionMarketingConsentFilter

Column	Type	Relates to	Notes
RemoteID	string	-	-
SegmentConditionMarketingConsentRemoteID	string	SegmentConditionMarketingConsent → RemoteID	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
ConditionMarketingConsentID	string	SegmentConditionMarketingConsent → RemoteID	-
Iterator	int	-	-
Field	string	-	-
Method	string	-	-
Property	string	-	-
Type	string	-	-
Operator	string	-	-
Unit	string	-	-
PredictedChannel	string	-	-
Date	datetime	-	-
StartDate	datetime	-	-
EndDate	datetime	-	-
StartDateInt	int	-	-
EndDateInt	int	-	-
Value	string	-	-
Quantity	decimal	-	-