Klaviyo 数据模型参考文档

本页面列出了您运行 Klaviyo 数据转移时转移到 BigQuery 的数据。 数据整理到表格中，其中列出了每个字段名称、关联的目标数据类型以及源数据中的 JSON 路径。

账号

Klaviyo 账号信息和元数据。

  • 表名称：Accounts
  • 端点：/accounts
  • Klaviyo API 参考文档：获取账号
字段名称 类型 JSONPath 说明
type STRING $.type 资源类型（始终为 account）。
id STRING $.id 相应账号的唯一标识符。
test_account STRING $.attributes.test_account 指明相应账号是否为测试账号。
default_sender_name STRING $.attributes.contact_information.default_sender_name 用作电子邮件发件人的默认名称。
default_sender_email STRING $.attributes.contact_information.default_sender_email 用作发件人的默认电子邮件地址。
website_url STRING $.attributes.contact_information.website_url 组织的网站网址。
organization_name STRING $.attributes.contact_information.organization_name 组织名称。
address1 STRING $.attributes.contact_information.street_address.address1 街道地址第 1 行。
address2 STRING $.attributes.contact_information.street_address.address2 街道地址第 2 行。
city STRING $.attributes.contact_information.street_address.city 组织的所在城市。
region STRING $.attributes.contact_information.street_address.region 州、省或区域。
country STRING $.attributes.contact_information.street_address.country 国家/地区。
zip STRING $.attributes.contact_information.street_address.zip 邮政编码。
industry STRING $.attributes.industry 相应账号的垂直行业。
timezone STRING $.attributes.timezone 账号的时区设置。
preferred_currency STRING $.attributes.preferred_currency 账号使用的主要币种。
public_api_key STRING $.attributes.public_api_key 用于客户端集成的公开 API 密钥（网站 ID）。
locale STRING $.attributes.locale 语言区域设置（例如 en-US）。

优惠券

用于折扣和促销活动的优惠券。

  • 表名称：Coupons
  • 端点：/coupons
  • Klaviyo API 参考文档：Get Coupons
字段名称 类型 JSONPath 说明
type STRING $.type 资源类型（始终为 coupon）。
id STRING $.id 优惠券的唯一内部标识符。
external_id STRING $.attributes.external_id 外部标识符（通常与名称/ID 相同）。
description STRING $.attributes.description 优惠券优惠的说明。
low_balance_threshold STRING $.attributes.monitor_configuration.low_balance_threshold 触发余额不足提醒的阈值。

CouponCode

为特定优惠券生成的唯一代码。

字段名称 类型 JSONPath 说明
type STRING $.type 资源类型（始终为 coupon-code）。
id STRING $.id 相应代码实例的唯一标识符。
unique_code STRING $.attributes.unique_code 实际的字母数字代码字符串。
expires_at 时间戳 $.attributes.expires_at 相应代码的失效时间戳。
status STRING $.attributes.status 代码的状态（例如ASSIGNED、UNASSIGNED）。
coupon_id STRING $.relationships.coupon.data.id 父优惠券定义的 ID。

事件

为个人资料跟踪的活动事件（例如，下单、查看商品）。

  • 表名称：Events
  • 端点：/events
  • Klaviyo API 参考文档：获取活动
字段名称 类型 JSONPath 说明
type STRING $.type 资源类型（始终为 event）。
id STRING $.id 事件的唯一标识符。
timestamp FLOAT $.attributes.timestamp 相应事件发生的 Unix 时间戳。
event_properties JSON $.attributes.event_properties 特定于事件类型的自定义 JSON 属性（例如，订单中的商品）。
datetime 时间戳 $.attributes.datetime 相应事件的 ISO 8601 时间戳。
uuid STRING $.attributes.uuid 相应事件的通用唯一标识符。
profile_id STRING $.relationships.profile.data.id 与活动关联的商家资料（客户）的 ID。
metric_id STRING $.relationships.metric.data.id 指标（事件类型）定义的 ID。
attribution_ids REPEATED STRING $.relationships.attributions.data[*].id 归因于相应事件的广告系列/流程的 ID。

Flows

由特定事件或条件触发的自动化营销流程。

  • 表名称：Flows
  • 端点：/flows
  • Klaviyo API 参考文档：Get Flows
字段名称 类型 JSONPath 说明
type STRING $.type 资源类型（始终为 flow）。
id STRING $.id 流程的唯一标识符。
name STRING $.attributes.name 流的名称。
status STRING $.attributes.status 运营状态（例如，有效、草稿）。
archived BOOLEAN $.attributes.archived 相应流程是否已归档。
created 时间戳 $.attributes.created 创建时间戳。
updated 时间戳 $.attributes.updated 上次修改时间戳。
trigger_type STRING $.attributes.trigger_type 触发流程的机制（例如，“已添加到列表”“指标”）。
flow_actions_ids REPEATED STRING $.relationships.flow-actions.data[*].id 相应流程中操作（步骤）的 ID。
tag_ids REPEATED STRING $.relationships.tags.data[*].id 分配给相应流程的标记的 ID。

表单

用于收集订阅者信息的注册表单。

  • 表名称：Forms
  • 端点：/forms
  • Klaviyo API 参考文档：获取表单
字段名称 类型 JSONPath 说明
type STRING $.type 资源类型（始终为 form）。
id STRING $.id 表单的唯一标识符。
name STRING $.attributes.name 表单的名称。
status STRING $.attributes.status 表单的状态（例如，有效、草稿）。
ab_test BOOLEAN $.attributes.ab_test 表单是否正在运行 A/B 测试。
created_at 时间戳 $.attributes.created_at 创建时间戳。
updated_at 时间戳 $.attributes.updated_at 上次修改时间戳。

图片

上传到 Klaviyo 以便在广告系列和模板中使用的图片。

  • 表名称：Images
  • 端点：/images
  • Klaviyo API 参考文档：获取图片
字段名称 类型 JSONPath 说明
type STRING $.type 资源类型（始终为 image）。
id STRING $.id 唯一标识符。
name STRING $.attributes.name 图片的文件名或名称。
image_url STRING $.attributes.image_url 用于访问图片的公开网址。
format STRING $.attributes.format 图片文件格式（例如，jpeg、png）。
size FLOAT $.attributes.size 文件大小（以字节为单位）。
hidden BOOLEAN $.attributes.hidden 图片是否在界面中处于隐藏状态。
updated_at 时间戳 $.attributes.updated_at 上次修改时间戳。

列表

联系人/个人资料的静态列表。

  • 表名称：列表
  • 端点：/lists
  • Klaviyo API 参考文档：Get Lists
字段名称 类型 JSONPath 说明
type STRING $.type 资源类型（始终为 list）。
id STRING $.id 列表的唯一标识符。
name STRING $.attributes.name 相应联系人列表的名称。
created 时间戳 $.attributes.created 创建时间戳。
updated 时间戳 $.attributes.updated 上次修改时间戳。
opt_in_process STRING $.attributes.opt_in_process 选择启用设置（例如，“single_opt_in”或“double_opt_in”）。
tag_ids REPEATED STRING $.relationships.tags.data[*].id 分配给相应列表的标记的 ID。
flow_triggers_ids REPEATED STRING $.relationships.flow-triggers.data[*].id 通过将个人资料添加到此列表触发的流程的 ID。

指标

可跟踪的事件类型（例如，“收到的电子邮件”）。

  • 表名称：指标
  • 端点：/metrics
  • Klaviyo API 参考文档：Get Metrics
字段名称 类型 JSONPath 说明
type STRING $.type 资源类型（始终为 metric）。
id STRING $.id 唯一标识符（例如6 个字符的代码（用于通用 UUID，自定义 UUID 则为较长的代码）。
name STRING $.attributes.name 人类可读的名称（例如，“已下单”）。
created 时间戳 $.attributes.created 创建时间戳。
updated 时间戳 $.attributes.updated 上次修改时间戳。
integration JSON $.attributes.integration 提供相应指标的集成相关信息（例如名称、类别、图片）。
flow_triggers_ids REPEATED STRING $.relationships.flow-triggers.data[*].id 相应指标触发的流程的 ID。

个人资料

包含属性和活动历史记录的全面客户档案。

字段名称 类型 JSONPath 说明
type STRING $.type 资源类型（始终为 profile）。
id STRING $.id 相应个人资料的唯一 Klaviyo ID。
email STRING $.attributes.email 主电子邮件地址。
phone_number STRING $.attributes.phone_number 采用 E.164 格式的电话号码。
external_id STRING $.attributes.external_id 外部系统中的 ID。
first_name STRING $.attributes.first_name 名字。
last_name STRING $.attributes.last_name 姓氏。
organization STRING $.attributes.organization 公司或组织名称。
locale STRING $.attributes.locale 语言区域/语言设置。
title STRING $.attributes.title 职位。
image STRING $.attributes.image 个人资料图片网址。
created 时间戳 $.attributes.created 个人资料创建时间戳。
updated 时间戳 $.attributes.updated 上次更新时间戳。
last_event_date 时间戳 $.attributes.last_event_date 最近一次事件的时间戳。
address1 STRING $.attributes.location.address1 地址第 1 行。
address2 STRING $.attributes.location.address2 地址第 2 行。
city STRING $.attributes.location.city 城市。
country STRING $.attributes.location.country 国家/地区。
latitude STRING $.attributes.location.latitude 纬度坐标。
longitude STRING $.attributes.location.longitude 经度坐标。
region STRING $.attributes.location.region 省/直辖市/自治区或地区。
zip STRING $.attributes.location.zip 邮政编码。
timezone STRING $.attributes.location.timezone 时区。
ip STRING $.attributes.location.ip 无需使用外部IP地址
properties JSON $.attributes.properties 自定义属性键值对。
email_marketing_can_receive_email_marketing BOOLEAN $.attributes.subscriptions.email.marketing.can_receive_email_marketing 相应商家资料是否可以接收电子邮件营销。
email_marketing_consent STRING $.attributes.subscriptions.email.marketing.consent 用户意见征求状态（例如SUBSCRIBED、UNSUBSCRIBED）。
email_marketing_consent_timestamp 时间戳 $.attributes.subscriptions.email.marketing.consent_timestamp 用户表示同意的时间。
email_marketing_last_updated 时间戳 $.attributes.subscriptions.email.marketing.last_updated 电子邮件同意情况的上次更新时间。
email_marketing_method STRING $.attributes.subscriptions.email.marketing.method 意见征求方式（例如 表单）。
email_marketing_method_detail STRING $.attributes.subscriptions.email.marketing.method_detail 方法的具体来源。
email_marketing_custom_method_detail STRING $.attributes.subscriptions.email.marketing.custom_method_detail 意见征求方法的自定义详细信息。
email_marketing_double_optin BOOLEAN $.attributes.subscriptions.email.marketing.double_optin 双重订阅是否已完成。
sms_marketing_can_receive_sms_marketing BOOLEAN $.attributes.subscriptions.sms.marketing.can_receive_sms_marketing 相应商家资料是否可以接收短信营销。
sms_marketing_consent STRING $.attributes.subscriptions.sms.marketing.consent 短信同意情况。
sms_marketing_consent_timestamp 时间戳 $.attributes.subscriptions.sms.marketing.consent_timestamp 用户同意接收短信的时间。
sms_marketing_last_updated 时间戳 $.attributes.subscriptions.sms.marketing.last_updated 上次更新短信同意情况的时间。
sms_marketing_method STRING $.attributes.subscriptions.sms.marketing.method 短信意见征求方法。
sms_marketing_method_detail STRING $.attributes.subscriptions.sms.marketing.method_detail 短信意见征求方法的详细信息。
sms_transactional_can_receive_sms_transactional BOOLEAN $.attributes.subscriptions.sms.transactional.can_receive_sms_transactional 相应配置文件是否可以接收交易类短信。
sms_transactional_consent STRING $.attributes.subscriptions.sms.transactional.consent 事务性短信的意见征求状态。
sms_transactional_consent_timestamp 时间戳 $.attributes.subscriptions.sms.transactional.consent_timestamp 用户何时同意接收事务性电子邮件。
sms_transactional_last_updated 时间戳 $.attributes.subscriptions.sms.transactional.last_updated 上次更新交易状态的时间。
sms_transactional_method STRING $.attributes.subscriptions.sms.transactional.method 事务性短信方法。
sms_transactional_method_detail STRING $.attributes.subscriptions.sms.transactional.method_detail 交易类短信方法详细信息。
mobile_push_can_receive_push_marketing BOOLEAN $.attributes.subscriptions.mobile_push.marketing.can_receive_push_marketing 相应个人资料是否可以接收推送营销内容。
mobile_push_consent STRING $.attributes.subscriptions.mobile_push.marketing.consent 推送同意情况。
mobile_push_consent_timestamp 时间戳 $.attributes.subscriptions.mobile_push.marketing.consent_timestamp 用户同意接收推送通知的时间。
predictive_analytics_historic_number_of_orders FLOAT $.attributes.predictive_analytics.historic_number_of_orders 历史订单总数。
predictive_analytics_predicted_number_of_orders FLOAT $.attributes.predictive_analytics.predicted_number_of_orders 预测的未来订单。
predictive_analytics_average_days_between_orders FLOAT $.attributes.predictive_analytics.average_days_between_orders 平均订单间隔天数。
predictive_analytics_average_order_value FLOAT $.attributes.predictive_analytics.average_order_value 历史平均订单价值。
predictive_analytics_historic_clv FLOAT $.attributes.predictive_analytics.historic_clv 历史客户生命周期价值。
predictive_analytics_predicted_clv FLOAT $.attributes.predictive_analytics.predicted_clv 预测的客户生命周期价值。
predictive_analytics_total_clv FLOAT $.attributes.predictive_analytics.total_clv 历史 CLV + 预测 CLV。
predictive_analytics_churn_probability FLOAT $.attributes.predictive_analytics.churn_probability 流失概率（0-1）。
predictive_analytics_expected_date_of_next_order 时间戳 $.attributes.predictive_analytics.expected_date_of_next_order 预测的下次订购日期。
email_marketing_suppression_reason 重复 JSON $.attributes.subscriptions.email.marketing.suppression[*] 电子邮件屏蔽原因（例如，退回）。
email_marketing_list_suppressions_reason 重复 JSON $.attributes.subscriptions.email.marketing.list_suppressions[*] 特定于列表的屏蔽原因。
push_tokens_ids REPEATED STRING $.relationships.push-tokens.data[*].id 关联的推送令牌 ID。

评价

客户提交的商品评价。

  • 表名称：Reviews
  • 端点：/reviews
  • Klaviyo API 参考文档：获取评价
字段名称 类型 JSONPath 说明
type STRING $.type 资源类型（始终为 review）。
id STRING $.id 评价的唯一标识符。
email STRING $.attributes.email 评价者的电子邮件地址。
value STRING $.attributes.status.value 状态值（例如，已发布、被拒）。
reason STRING $.attributes.status.rejection_reason.reason 拒绝原因（如适用）。
status_explanation STRING $.attributes.status.rejection_reason.status_explanation 状态的详细说明。
verified BOOLEAN $.attributes.verified 购买交易是否已通过验证。
review_type STRING $.attributes.review_type 评价类型（例如，商品评价）。
created 时间戳 $.attributes.created 创建时间戳。
updated 时间戳 $.attributes.updated 上次修改时间戳。
images REPEATED STRING $.attributes.images[*] 评价中附加的图片的网址。
product_url STRING $.attributes.product.url 被评商品的网址。
product_name STRING $.attributes.product.name 商品的名称。
product_image_url STRING $.attributes.product.image_url 商品的图片网址。
product_external_id STRING $.attributes.product.external_id 商品的外部 ID。
rating INTEGER $.attributes.rating 评分。
author STRING $.attributes.author 评价者的姓名。
content STRING $.attributes.content 评价的文字内容。
title STRING $.attributes.title 评价的标题。
smart_quote STRING $.attributes.smart_quote 评价中突出显示的引文。
public_reply_content STRING $.attributes.public_reply.content 商家公开回复的内容。
public_reply_author STRING $.attributes.public_reply.author 回复的作者。
public_reply_updated STRING $.attributes.public_reply.updated 回复更新的时间戳。
event_ids REPEATED STRING $.relationships.events.data[*].id 关联的活动 ID。

路段

根据特定条件创建的动态个人资料群组。

  • 表名称：Segments
  • 端点：/segments
  • Klaviyo API 参考文档：获取细分
字段名称 类型 JSONPath 说明
type STRING $.type 资源类型（始终为 segment）。
id STRING $.id 细分的唯一标识符。
name STRING $.attributes.name 细分名称。
created 时间戳 $.attributes.created 创建时间戳。
updated 时间戳 $.attributes.updated 上次修改时间戳。
is_active BOOLEAN $.attributes.is_active 细分受众群是否处于有效状态。
is_processing BOOLEAN $.attributes.is_processing 相应细分受众群是否正在处理中。
is_starred BOOLEAN $.attributes.is_starred 相应细分是否已加星标/收藏。
tag_ids REPEATED STRING $.relationships.tags.data[*].id 关联代码的 ID。
flow_triggers_ids REPEATED STRING $.relationships.flow-triggers.data[*].id 相应细分触发的流程的 ID。
condition_groups REPEATED RECORD $.attributes.definition.condition_groups[*] 定义细分的逻辑条件组。

ConditionGroup

字段名称 类型 JSONPath 说明
conditions REPEATED 条件 conditions[*] 组内的各个条件的列表。

条件

字段名称 类型 JSONPath 说明
type STRING type 条件的类型（例如 profile-property）。
value JSON N/A 条件值/配置。

标记

用于整理广告系列、流程和列表的标记。

  • 表名称：Tags
  • 端点：/tags
  • Klaviyo API 参考文档：Get Tags
字段名称 类型 JSONPath 说明
type STRING $.type 资源类型（始终为 tag）。
id STRING $.id 代码的唯一标识符。
name STRING $.attributes.name 标记的名称。
tag_group_id STRING $.relationships.tag-group.data.id 相应代码所属的代码组的 ID。

模板

电子邮件和消息模板。

  • 表名称：Templates
  • 端点：/templates
  • Klaviyo API 参考文档：获取模板
字段名称 类型 JSONPath 说明
type STRING $.type 资源类型（始终为 template）。
id STRING $.id 唯一标识符。
name STRING $.attributes.name 模板名称。
editor_type STRING $.attributes.editor_type 所用编辑器（例如，拖放编辑器）。
html STRING $.attributes.html HTML 内容
text STRING $.attributes.text 模板的文本版本。
amp STRING $.attributes.amp 模板的 AMP 版本。
created 时间戳 $.attributes.created 创建时间戳。
updated 时间戳 $.attributes.updated 上次更新时间戳。

WebFeeds

用于在消息中填充内容的 Web Feed。

  • 表名称：WebFeeds
  • 端点：/web-feeds
  • Klaviyo API 参考文档：Get Web Feeds
字段名称 类型 JSONPath 说明
type STRING $.type 资源类型（始终为 web-feed）。
id STRING $.id 唯一标识符。
name STRING $.attributes.name Feed 名称。
url STRING $.attributes.url Feed 来源网址。
request_method STRING $.attributes.request_method HTTP 方法 (GET/POST)。
content_type STRING $.attributes.content_type 内容类型（例如，JSON）。
status STRING $.attributes.status Feed 的状态。
created 时间戳 $.attributes.created 创建时间戳。
updated 时间戳 $.attributes.updated 上次更新时间戳。

DataSources

集成到 Klaviyo 中的数据源。

  • 表名称：DataSources
  • 端点：/data-sources
  • Klaviyo API 参考文档：获取数据源
字段名称 类型 JSONPath 说明
type STRING $.type 资源类型（始终为 data-source）。
id STRING $.id 唯一标识符。
title STRING $.attributes.title 数据源的标题。
visibility STRING $.attributes.visibility 公开范围级别。
description STRING $.attributes.description 说明文字。

广告系列

发送给名单或细分受众群的营销广告系列。

  • 表名称：Campaigns
  • 端点：/campaigns
  • Klaviyo API 参考文档：Get Campaigns
字段名称 类型 JSONPath 说明
type STRING $.type 资源类型（始终为 campaign）。
id STRING $.id 唯一标识符。
name STRING $.attributes.name 广告系列名称。
status STRING $.attributes.status 广告系列状态（例如，已发送，正在安排）。
archived BOOLEAN $.attributes.archived 广告系列是否已归档。
included REPEATED STRING $.attributes.audiences.included 纳入的名单/细分受众群的 ID。
excluded REPEATED STRING $.attributes.audiences.excluded 排除的列表/细分受众群的 ID。
send_options JSON $.attributes.send_options 发送配置（例如，智能发送）。
tracking_options JSON $.attributes.tracking_options 跟踪配置（例如，UTM 参数）。
send_strategy JSON $.attributes.send_strategy 送货时间策略。
created_at 时间戳 $.attributes.created_at 创建时间戳。
scheduled_at 时间戳 $.attributes.scheduled_at 宣传活动的计划发送时间。
updated_at 时间戳 $.attributes.updated_at 上次更新时间戳。
send_time 时间戳 $.attributes.send_time 实际发送时间。
tag_ids REPEATED STRING $.relationships.tags.data[*].id 关联代码的 ID。
campaign_message_ids REPEATED STRING $.relationships.campaign-messages.data[*].id 相应广告系列中包含的消息的 ID。

CampaignMessages

宣传活动中的各个邮件/短信。

  • 表名称：CampaignMessages
  • 端点：/campaign-messages
  • Klaviyo API 参考文档：Get Campaign Message
字段名称 类型 JSONPath 说明
type STRING $.type 资源类型（始终为 campaign-message）。
id STRING $.id 唯一标识符。
definition JSON $.attributes.definition 消息内容和配置。
send_times 重复 JSON $.attributes.send_times[*] 安排发送时间。
created_at 时间戳 $.attributes.created_at 创建时间戳。
updated_at 时间戳 $.attributes.updated_at 上次更新时间戳。
campaign_id STRING $.relationships.campaign.data.id 父级广告系列的 ID。
template_id STRING $.relationships.template.data.id 所用模板的 ID。
image_id STRING $.relationships.image.data.id 附加图片的 ID。

类别

您目录中的商品类别。

  • 表名称：Categories
  • 端点：/catalog-categories
  • Klaviyo API 参考文档：获取目录类别
字段名称 类型 JSONPath 说明
type STRING $.type 资源类型。
id STRING $.id 唯一标识符。
name STRING $.attributes.name 类别名称。
external_id STRING $.attributes.external_id 外部系统 ID。
updated 时间戳 $.attributes.updated 上次更新时间戳。

内容

商品目录中的各个商品或项目。

  • 表名称：Items
  • 端点：/catalog-items
  • Klaviyo API 参考文档：获取目录项
字段名称 类型 JSONPath 说明
type STRING $.type 资源类型。
id STRING $.id 唯一标识符。
external_id STRING $.attributes.external_id 外部系统 ID。
title STRING $.attributes.title 商品名。
description STRING $.attributes.description 提供说明。
price FLOAT $.attributes.price 商品的价格。
url STRING $.attributes.url 商品的网址。
image_full_url STRING $.attributes.image_full_url 全尺寸图片的网址。
image_thumbnail_url STRING $.attributes.image_thumbnail_url 缩略图的网址。
images REPEATED STRING $.attributes.images[*] 附加图片网址列表。
custom_metadata JSON $.attributes.custom_metadata 自定义元数据键值对。
published BOOLEAN $.attributes.published 发布状态。
created 时间戳 $.attributes.created 创建时间戳。
updated 时间戳 $.attributes.updated 上次更新时间戳。
variants_ids REPEATED STRING $.relationships.variants.data[*].id 相应商品的变体的 ID。

变体

商品目录中商品的特定款式/规格（例如尺寸、颜色）。

  • 表名称：Variants
  • 端点：/catalog-variants
  • Klaviyo API 参考文档：获取目录变体
字段名称 类型 JSONPath 说明
type STRING $.type 资源类型。
id STRING $.id 唯一标识符。
external_id STRING $.attributes.external_id 外部系统 ID。
title STRING $.attributes.title Variant title [款式/规格名称]。
description STRING $.attributes.description 提供说明。
sku STRING $.attributes.sku 库存单元。
inventory_policy FLOAT $.attributes.inventory_policy 广告资源管理政策。
inventory_quantity FLOAT $.attributes.inventory_quantity 当前库存数量。
price FLOAT $.attributes.price 价格。
url STRING $.attributes.url 变体的网址。
image_full_url BOOLEAN $.attributes.image_full_url 完整图片网址是否可用（布尔值）。
image_thumbnail_url STRING $.attributes.image_thumbnail_url 缩略图网址。
images REPEATED STRING $.attributes.images[*] 图片列表。
published BOOLEAN $.attributes.published 发布状态。
created 时间戳 $.attributes.created 创建时间戳。
updated 时间戳 $.attributes.updated 上次更新时间戳。