Klaviyo 資料模型參考資料

本頁列出執行 Klaviyo 資料移轉作業時，會移轉至 BigQuery 的資料。資料會整理成表格，列出每個欄位名稱、相關聯的目的地資料類型，以及來源資料的 JSON 路徑。

帳戶

Klaviyo 帳戶資訊和中繼資料。

  • 資料表名稱：Accounts
  • 端點：/accounts
  • Klaviyo API 參考資料：Get Accounts
欄位名稱 類型 JSON 路徑 說明
type STRING $.type 資源類型 (一律為 account)。
id STRING $.id 帳戶的專屬 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
  • Klaviyo API 參考資料：Get Coupons
欄位名稱 類型 JSON 路徑 說明
type STRING $.type 資源類型 (一律為 coupon)。
id STRING $.id 優待券的內部專屬 ID。
external_id STRING $.attributes.external_id 外部 ID (通常與名稱/ID 相同)。
description STRING $.attributes.description 優待券優惠說明。
low_balance_threshold STRING $.attributes.monitor_configuration.low_balance_threshold 觸發餘額偏低快訊的門檻。

CouponCode

為特定優待券產生的個別專屬代碼。

  • 資料表名稱：CouponCode
  • 端點：/coupon-codes
  • Klaviyo API 參考資料：取得優惠碼
欄位名稱 類型 JSON 路徑 說明
type STRING $.type 資源類型 (一律為 coupon-code)。
id STRING $.id 這個程式碼執行個體的專屬 ID。
unique_code STRING $.attributes.unique_code 實際的英數字元代碼字串。
expires_at TIMESTAMP $.attributes.expires_at 這個代碼的到期時間戳記。
status STRING $.attributes.status 代碼狀態 (例如 ASSIGNED、UNASSIGNED)。
coupon_id STRING $.relationships.coupon.data.id 上層優待券定義的 ID。

活動

為設定檔追蹤的活動事件 (例如「已下單」、「已查看產品」)。

欄位名稱 類型 JSON 路徑 說明
type STRING $.type 資源類型 (一律為 event)。
id STRING $.id 事件的專屬 ID。
timestamp FLOAT $.attributes.timestamp 事件發生時的 Unix 時間戳記。
event_properties JSON $.attributes.event_properties 事件類型專屬的自訂 JSON 屬性 (例如訂單中的商品)。
datetime TIMESTAMP $.attributes.datetime 事件的 ISO 8601 時間戳記。
uuid STRING $.attributes.uuid 事件的通用專屬 ID。
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
  • Klaviyo API 參考資料：Get Flows
欄位名稱 類型 JSON 路徑 說明
type STRING $.type 資源類型 (一律為 flow)。
id STRING $.id 流程的專屬 ID。
name STRING $.attributes.name 流程名稱。
status STRING $.attributes.status 運作狀態 (例如：有效、草稿)。
archived BOOLEAN $.attributes.archived 流程是否已封存。
created TIMESTAMP $.attributes.created 建立時間戳記。
updated TIMESTAMP $.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。

表單

收集訂閱者資訊的註冊表單。

欄位名稱 類型 JSON 路徑 說明
type STRING $.type 資源類型 (一律為 form)。
id STRING $.id 表單的專屬 ID。
name STRING $.attributes.name 表單名稱。
status STRING $.attributes.status 表單狀態 (例如：有效、草稿)。
ab_test BOOLEAN $.attributes.ab_test 表單是否正在執行 A/B 測試。
created_at TIMESTAMP $.attributes.created_at 建立時間戳記。
updated_at TIMESTAMP $.attributes.updated_at 上次修改時間戳記。

圖片

上傳到 Klaviyo 的圖片，用於廣告活動和範本。

欄位名稱 類型 JSON 路徑 說明
type STRING $.type 資源類型 (一律為 image)。
id STRING $.id 專屬 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 TIMESTAMP $.attributes.updated_at 上次修改時間戳記。

清單

聯絡人/設定檔的靜態清單。

  • 資料表名稱：Lists
  • 端點：/lists
  • Klaviyo API 參考資料：Get Lists
欄位名稱 類型 JSON 路徑 說明
type STRING $.type 資源類型 (一律為 list)。
id STRING $.id 清單的專屬 ID。
name STRING $.attributes.name 聯絡人清單的名稱。
created TIMESTAMP $.attributes.created 建立時間戳記。
updated TIMESTAMP $.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。

指標

可追蹤的事件類型 (例如「收到電子郵件」)。

欄位名稱 類型 JSON 路徑 說明
type STRING $.type 資源類型 (一律為 metric)。
id STRING $.id 專屬 ID (例如一般 ID 為 6 個字元的代碼，自訂 ID 為長 UUID)。
name STRING $.attributes.name 人類可讀的名稱 (例如「已下單」)。
created TIMESTAMP $.attributes.created 建立時間戳記。
updated TIMESTAMP $.attributes.updated 上次修改時間戳記。
integration JSON $.attributes.integration 提供這項指標的整合資訊 (例如名稱、類別、圖片)。
flow_triggers_ids REPEATED STRING $.relationships.flow-triggers.data[*].id 這項指標觸發的流程 ID。

設定檔

包含屬性和活動記錄的完整顧客資料。

  • 資料表名稱：Profiles
  • 端點：/profiles
  • Klaviyo API 參考資料：Get Profiles
欄位名稱 類型 JSON 路徑 說明
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 TIMESTAMP $.attributes.created 建立設定檔的時間戳記。
updated TIMESTAMP $.attributes.updated 上次更新時間戳記。
last_event_date TIMESTAMP $.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 同意聲明狀態 (例如「已訂閱」、「已取消訂閱」)。
email_marketing_consent_timestamp TIMESTAMP $.attributes.subscriptions.email.marketing.consent_timestamp 使用者同意的時間。
email_marketing_last_updated TIMESTAMP $.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 TIMESTAMP $.attributes.subscriptions.sms.marketing.consent_timestamp 同意接收簡訊的時間。
sms_marketing_last_updated TIMESTAMP $.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 TIMESTAMP $.attributes.subscriptions.sms.transactional.consent_timestamp 同意交易的時間。
sms_transactional_last_updated TIMESTAMP $.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 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。
predictive_analytics_churn_probability FLOAT $.attributes.predictive_analytics.churn_probability 流失機率 (0-1)。
predictive_analytics_expected_date_of_next_order TIMESTAMP $.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 參考資料：Get Reviews
欄位名稱 類型 JSON 路徑 說明
type STRING $.type 資源類型 (一律為 review)。
id STRING $.id 評論的專屬 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 TIMESTAMP $.attributes.created 建立時間戳記。
updated TIMESTAMP $.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 參考資料：Get Segments
欄位名稱 類型 JSON 路徑 說明
type STRING $.type 資源類型 (一律為 segment)。
id STRING $.id 區隔的專屬 ID。
name STRING $.attributes.name 區隔名稱。
created TIMESTAMP $.attributes.created 建立時間戳記。
updated TIMESTAMP $.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

欄位名稱 類型 JSON 路徑 說明
conditions REPEATED 條件 conditions[*] 群組中的個別條件清單。

條件

欄位名稱 類型 JSON 路徑 說明
type STRING type 條件類型 (例如 profile-property)。
value JSON N/A 條件值/設定。

標記

用於整理廣告活動、流程和名單的標記。

  • 資料表名稱：Tags
  • 端點：/tags
  • Klaviyo API 參考資料：取得標籤
欄位名稱 類型 JSON 路徑 說明
type STRING $.type 資源類型 (一律為 tag)。
id STRING $.id 專屬代碼 ID。
name STRING $.attributes.name 標記名稱。
tag_group_id STRING $.relationships.tag-group.data.id 這個標記所屬標記群組的 ID。

範本

電子郵件和訊息範本。

  • 資料表名稱：範本
  • 端點：/templates
  • Klaviyo API 參考資料：Get Templates
欄位名稱 類型 JSON 路徑 說明
type STRING $.type 資源類型 (一律為 template)。
id STRING $.id 專屬 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 TIMESTAMP $.attributes.created 建立時間戳記。
updated TIMESTAMP $.attributes.updated 上次更新時間戳記。

WebFeeds

用於在訊息中填入內容的網路動態饋給。

  • 資料表名稱：WebFeeds
  • 端點：/web-feeds
  • Klaviyo API 參考資料：Get Web Feeds
欄位名稱 類型 JSON 路徑 說明
type STRING $.type 資源類型 (一律為 web-feed)。
id STRING $.id 專屬 ID。
name STRING $.attributes.name 動態饋給名稱。
url STRING $.attributes.url 動態饋給來源網址。
request_method STRING $.attributes.request_method HTTP 方法 (GET/POST)。
content_type STRING $.attributes.content_type 內容類型 (例如 JSON)。
status STRING $.attributes.status 動態饋給的狀態。
created TIMESTAMP $.attributes.created 建立時間戳記。
updated TIMESTAMP $.attributes.updated 上次更新時間戳記。

DataSources

整合至 Klaviyo 的資料來源。

  • 資料表名稱：DataSources
  • 端點：/data-sources
  • Klaviyo API 參考資料：取得資料來源
欄位名稱 類型 JSON 路徑 說明
type STRING $.type 資源類型 (一律為 data-source)。
id STRING $.id 專屬 ID。
title STRING $.attributes.title 資料來源的標題。
visibility STRING $.attributes.visibility 顯示層級。
description STRING $.attributes.description 說明文字。

倡議活動

傳送給名單或區隔的行銷廣告活動。

欄位名稱 類型 JSON 路徑 說明
type STRING $.type 資源類型 (一律為 campaign)。
id STRING $.id 專屬 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 追蹤設定 (例如 Urchin 流量監視器參數)。
send_strategy JSON $.attributes.send_strategy 運送時間策略。
created_at TIMESTAMP $.attributes.created_at 建立時間戳記。
scheduled_at TIMESTAMP $.attributes.scheduled_at 排定傳送廣告活動的時間。
updated_at TIMESTAMP $.attributes.updated_at 上次更新時間戳記。
send_time TIMESTAMP $.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
欄位名稱 類型 JSON 路徑 說明
type STRING $.type 資源類型 (一律為 campaign-message)。
id STRING $.id 專屬 ID。
definition JSON $.attributes.definition 訊息內容和設定。
send_times REPEATED JSON $.attributes.send_times[*] 排定的傳送時間。
created_at TIMESTAMP $.attributes.created_at 建立時間戳記。
updated_at TIMESTAMP $.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。

類別

目錄中的產品類別。

欄位名稱 類型 JSON 路徑 說明
type STRING $.type 資源類型。
id STRING $.id 專屬 ID。
name STRING $.attributes.name 類別名稱。
external_id STRING $.attributes.external_id 外部系統 ID。
updated TIMESTAMP $.attributes.updated 上次更新時間戳記。

項目

目錄中的個別產品或項目。

  • 資料表名稱：Items
  • 端點：/catalog-items
  • Klaviyo API 參考資料：Get Catalog Items
欄位名稱 類型 JSON 路徑 說明
type STRING $.type 資源類型。
id STRING $.id 專屬 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 TIMESTAMP $.attributes.created 建立時間戳記。
updated TIMESTAMP $.attributes.updated 上次更新時間戳記。
variants_ids REPEATED STRING $.relationships.variants.data[*].id 這個項目的子類 ID。

變化版本

目錄項目的特定子類 (例如尺寸、顏色)。

  • 資料表名稱：Variants
  • 端點：/catalog-variants
  • Klaviyo API 參考資料：Get Catalog Variants
欄位名稱 類型 JSON 路徑 說明
type STRING $.type 資源類型。
id STRING $.id 專屬 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 TIMESTAMP $.attributes.created 建立時間戳記。
updated TIMESTAMP $.attributes.updated 上次更新時間戳記。

FlowActions

與流程相關聯的流程動作。

  • 資料表名稱：FlowActions
  • 端點：/flows/{id}/flow-actions
  • Klaviyo API 參考資料：Get Flow Actions
欄位名稱 類型 JSON 路徑 說明
type STRING $.type 資源類型。一律flow-action。
id STRING $.id 流程動作的專屬 ID。
created TIMESTAMP $.attributes.created 建立時間戳記。
updated TIMESTAMP $.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 參考資料：Get Form Versions
欄位名稱 類型 JSON 路徑 說明
type STRING $.type 資源類型。一律form-version。
id STRING $.id 表單版本的專屬 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 TIMESTAMP $.attributes.created_at 建立時間戳記。
updated_at TIMESTAMP $.attributes.updated_at 上次修改時間戳記。

PushTokens

與行動應用程式設定檔相關聯的推播權杖，用於推播通知。

  • 資料表名稱：PushTokens
  • 端點：/push-tokens
  • Klaviyo API 參考資料：取得推播權杖
欄位名稱 類型 JSON 路徑 說明
type STRING $.type 資源類型。一律push-token。
id STRING $.id 推送權杖的專屬 ID。
created TIMESTAMP $.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 TIMESTAMP $.attributes.recorded_date 記錄推送權杖的日期。
metadata JSON $.attributes.metadata 自訂裝置或推播權杖中繼資料。
profile_id STRING $.relationships.profile.data.id 與這個推送權杖相關聯的顧客個人資料 ID。

TagGroups

標記群組，用於整理及分類標記。

  • 資料表名稱：TagGroups
  • 端點：/tag-groups
  • Klaviyo API 參考資料：取得標籤組
欄位名稱 類型 JSON 路徑 說明
type STRING $.type 資源類型。一律tag-group。
id STRING $.id 標記群組的專屬 ID。
name STRING $.attributes.name 標記群組名稱。
exclusive BOOLEAN $.attributes.exclusive 這個群組中的標記是否互斥。
default BOOLEAN $.attributes.default 這是否為帳戶的預設標記群組。

UniversalContent

可重複使用的通用內容區塊，用於訊息和範本。

  • 資料表名稱：UniversalContent
  • 端點：/template-universal-content
  • Klaviyo API 參考資料：Get Universal Content
欄位名稱 類型 JSON 路徑 說明
type STRING $.type 資源類型。一律template-universal-content。
id STRING $.id 通用內容區塊的專屬 ID。
name STRING $.attributes.name 通用內容區塊的名稱。
definition_content_type STRING $.attributes.definition.content_type 定義的內容類型，例如 block、template。
definition_type STRING $.attributes.definition.type 內容的元件類型，例如 text、button、image。
definition_data JSON $.attributes.definition.data 內容定義的結構資料和酬載。
created TIMESTAMP $.attributes.created 建立時間戳記。
updated TIMESTAMP $.attributes.updated 上次修改時間戳記。
screenshot_status STRING $.attributes.screenshot_status 預覽螢幕截圖生成狀態，例如 completed、pending。
screenshot_url STRING $.attributes.screenshot_url 內容預覽螢幕截圖的公開網址。

MetricProperties

為特定指標定義的屬性和結構屬性。

  • 資料表名稱：MetricProperties
  • 端點：/metrics/{id}/metric-properties
  • Klaviyo API 參考資料：Get Metric Properties
欄位名稱 類型 JSON 路徑 說明
type STRING $.type 資源類型。一律metric-property。
id STRING $.id 指標屬性的專屬 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

廣告活動和流程的帳戶層級 Urchin 流量監視器 (UTM) 追蹤參數。

  • 資料表名稱：TrackingSettings
  • 端點：/tracking-settings
  • Klaviyo API 參考資料：Get Tracking Settings
欄位名稱 類型 JSON 路徑 說明
type STRING $.type 資源類型。一律tracking-setting。
id STRING $.id 追蹤設定的專屬 ID。
auto_add_parameters BOOLEAN $.attributes.auto_add_parameters 是否自動在訊息連結中加入 Urchin 流量監視器 (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

欄位名稱 類型 JSON 路徑 說明
flow ParameterContext flow 流程的 UTM 參數設定背景資訊。
campaign ParameterContext campaign 廣告活動的 Urchin 流量監視器 (UTM) 參數設定。

ParameterContext

欄位名稱 類型 JSON 路徑 說明
type STRING type 資源類型。
value STRING value 參數範本值或屬性鍵，例如 emailsubject、campaignid。

CustomParameter

欄位名稱 類型 JSON 路徑 說明
flow ParameterContext flow 流程的自訂追蹤參數背景資訊。
campaign ParameterContext campaign 廣告活動的自訂追蹤參數背景資訊。
name STRING name 自訂追蹤參數的名稱。