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 参考文档：获取优惠券
字段名称 类型 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 参考文档：获取流程
字段名称 类型 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
  • 端点：/lists
  • Klaviyo API 参考文档：获取列表
字段名称 类型 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 选择启用设置（例如“singleoptin”或“doubleoptin”）。
tag_ids REPEATED STRING $.relationships.tags.data[*].id 分配给此列表的标签的 ID。
flow_triggers_ids REPEATED STRING $.relationships.flow-triggers.data[*].id 通过向此列表添加个人资料而触发的工作流的 ID。

指标

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

  • 表名称：Metrics
  • 端点：/metrics
  • Klaviyo API 参考文档：获取指标
字段名称 类型 JSONPath 说明
type STRING $.type 资源类型（始终为 metric）。
id STRING $.id 唯一标识符（例如，通用标识符为 6 字符代码，自定义标识符为长 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 同意方式（例如 FORM）。
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 REPEATED JSON $.attributes.subscriptions.email.marketing.suppression[*] 电子邮件屏蔽原因（例如，退回）。
email_marketing_list_suppressions_reason REPEATED 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。

路段

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

字段名称 类型 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 ConditionGroup $.attributes.definition.condition_groups[*] 定义细分受众群的逻辑条件组。

ConditionGroup

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

条件

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

标记

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

  • 表名称：Tags
  • 端点：/tags
  • Klaviyo API 参考文档：获取标记
字段名称 类型 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

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

  • 表名称：WebFeeds
  • 端点：/web-feeds
  • Klaviyo API 参考文档：获取 Web Feed
字段名称 类型 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 说明文字。

广告系列

向名单或细分受众群发送的营销活动。

字段名称 类型 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

广告系列中的单条消息（邮件/短信）。

字段名称 类型 JSONPath 说明
type STRING $.type 资源类型（始终为 campaign-message）。
id STRING $.id 唯一标识符。
definition JSON $.attributes.definition 消息内容和配置。
send_times REPEATED 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 变体标题。
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 STRING $.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 上次更新时间戳。

FlowActions

与工作流关联的工作流操作。

  • 表名称：FlowActions
  • 端点：/flows/{id}/flow-actions
  • Klaviyo API 参考文档：获取流程操作
字段名称 类型 JSONPath 说明
type STRING $.type 资源类型。始终为 flow-action。
id STRING $.id 流程操作的唯一标识符。
created 时间戳 $.attributes.created 创建时间戳。
updated 时间戳 $.attributes.updated 上次修改时间戳。
message_id STRING $.attributes.definition.id 操作消息定义的唯一 ID。
message_temporary_id STRING $.attributes.definition.temporary_id 分配给消息定义的临时 ID。
message_type STRING $.attributes.definition.type 消息类型，例如 email、sms。
condition_groups REPEATED ConditionGroup $.attributes.definition.data.action_output_filter.condition_groups[*] 与流操作输出过滤条件关联的条件。
next_if_true STRING $.attributes.definition.links.next_if_true 如果条件评估结果为 true，则为下一个流操作的 ID。
next_if_false STRING $.attributes.definition.links.next_if_false 如果条件评估结果为 false，则为下一个流操作的 ID。

FormVersions

给定表单的表单版本。

  • 表名称：FormVersions
  • 端点：/forms/{id}/form-versions
  • Klaviyo API 参考文档：获取表单版本
字段名称 类型 JSONPath 说明
type STRING $.type 资源类型。始终为 form-version。
id STRING $.id 表单版本的唯一标识符。
form_type STRING $.attributes.form_type 表单类型，例如 popup、embed、banner。
variation_name STRING $.attributes.variation_name 表单变体的名称。
ab_test JSON $.attributes.ab_test A/B 测试配置和变体设置。
status STRING $.attributes.status 表单版本的运行状态，例如 draft、live。
created_at 时间戳 $.attributes.created_at 创建时间戳。
updated_at 时间戳 $.attributes.updated_at 上次修改时间戳。

PushTokens

与移动应用个人资料关联的推送令牌，用于推送通知。

  • 表名称：PushTokens
  • 端点：/push-tokens
  • Klaviyo API 参考文档：获取推送令牌
字段名称 类型 JSONPath 说明
type STRING $.type 资源类型。始终为 push-token。
id STRING $.id 推送令牌的唯一标识符。
created 时间戳 $.attributes.created 创建时间戳。
token STRING $.attributes.token 设备推送令牌字符串。
enablement_status STRING $.attributes.enablement_status 推送通知启用状态，例如 AUTHORIZED、UNAUTHORIZED。
platform STRING $.attributes.platform 移动平台，例如 ios、android。
vendor STRING $.attributes.vendor 供应商服务提供商，例如 apns、fcm。
background STRING $.attributes.background 推送通知的后台刷新状态。
recorded_date 时间戳 $.attributes.recorded_date 记录推送令牌的日期。
metadata JSON $.attributes.metadata 自定义设备或推送令牌元数据。
profile_id STRING $.relationships.profile.data.id 与此推送令牌关联的客户资料的 ID。

TagGroups

用于整理和分类代码的代码组。

  • 表名称：TagGroups
  • 端点：/tag-groups
  • Klaviyo API 参考文档：获取代码组
字段名称 类型 JSONPath 说明
type STRING $.type 资源类型。始终为 tag-group。
id STRING $.id 代码组的唯一标识符。
name STRING $.attributes.name 标记组的名称。
exclusive BOOLEAN $.attributes.exclusive 此组中的标记是否互斥。
default BOOLEAN $.attributes.default 这是否是账号的默认代码组。

UniversalContent

可重复使用的通用内容块，适用于消息和模板。

  • 表名称：UniversalContent
  • 端点：/template-universal-content
  • Klaviyo API 参考文档：获取通用内容
字段名称 类型 JSONPath 说明
type STRING $.type 资源类型。始终为 template-universal-content。
id STRING $.id 通用内容块的唯一标识符。
name STRING $.attributes.name 通用内容块的名称。
definition_content_type STRING $.attributes.definition.content_type 定义的 Content-Type，例如 block、template。
definition_type STRING $.attributes.definition.type 内容的组件类型，例如 text、button、image。
definition_data JSON $.attributes.definition.data 内容定义的结构化数据和载荷。
created 时间戳 $.attributes.created 创建时间戳。
updated 时间戳 $.attributes.updated 上次修改时间戳。
screenshot_status STRING $.attributes.screenshot_status 预览屏幕截图生成状态，例如 completed、pending。
screenshot_url STRING $.attributes.screenshot_url 内容预览屏幕截图的公开网址。

MetricProperties

为特定指标定义的属性和结构属性。

  • 表名称：MetricProperties
  • 端点：/metrics/{id}/metric-properties
  • Klaviyo API 参考文档：获取指标属性
字段名称 类型 JSONPath 说明
type STRING $.type 资源类型。始终为 metric-property。
id STRING $.id 指标属性的唯一标识符。
sample_values JSON $.attributes.sample_values 为此指标属性捕获的抽样数据值。
label STRING $.attributes.label 属性的人类可读标签。
property STRING $.attributes.property 事件属性的键名称。
inferred_type STRING $.attributes.inferred_type Klaviyo 为此属性推断的数据类型，例如 string、boolean、numeric。
metric_id STRING $.relationships.metric.data.id 父级指标定义的 ID。

TrackingSettings

适用于广告系列和流程的账号级 UTM 跟踪参数。

  • 表名称：TrackingSettings
  • 端点：/tracking-settings
  • Klaviyo API 参考文档：获取跟踪设置
字段名称 类型 JSONPath 说明
type STRING $.type 资源类型。始终为 tracking-setting。
id STRING $.id 跟踪设置的唯一标识符。
auto_add_parameters BOOLEAN $.attributes.auto_add_parameters 是否自动向消息链接添加 UTM 参数。
utm_source UtmParameter $.attributes.utm_source 在流程和广告系列中配置 _utm_source parameter。
utm_medium UtmParameter $.attributes.utm_medium 在流程和广告系列中配置 _utm_medium parameter。
utm_campaign UtmParameter $.attributes.utm_campaign 在流程和广告系列中配置 _utm_campaign 参数。
utm_id UtmParameter $.attributes.utm_id 在流程和广告系列中配置 _utm_id 参数。
utm_term UtmParameter $.attributes.utm_term 在流程和广告系列中配置 _utm_term 参数。
custom_parameters REPEATED CustomParameter $.attributes.custom_parameters 附加到广告系列和流程链接的自定义跟踪参数。

UtmParameter

字段名称 类型 JSONPath 说明
flow ParameterContext flow 流程的 UTM 参数设置上下文。
campaign ParameterContext campaign 广告系列的 UTM 参数设置上下文。

ParameterContext

字段名称 类型 JSONPath 说明
type STRING type 资源类型。
value STRING value 参数模板值或属性键，例如 emailsubject、campaignid。

CustomParameter

字段名称 类型 JSONPath 说明
flow ParameterContext flow 流程的自定义跟踪参数上下文。
campaign ParameterContext campaign 广告系列的自定义跟踪参数上下文。
name STRING name 自定义跟踪参数的名称。