הפניה למודל הנתונים של Klaviyo

בדף הזה מפורטים הנתונים שמועברים ל-BigQuery כשמפעילים העברת נתונים מ-Klaviyo. הנתונים מאורגנים בטבלאות שמפרטות את השם של כל שדה, את סוג נתוני היעד שמשויך אליו ואת נתיב ה-JSON מנתוני המקור.

חשבונות

פרטי החשבון והמטא-נתונים של Klaviyo.

  • שם הטבלה: Accounts
  • נקודת קצה: /accounts
  • מאמרי העזרה של Klaviyo API: Get Accounts
שם השדה סוג נתיב JSON תיאור
type מחרוזת $.type סוג המשאב (תמיד account).
id מחרוזת $.id המזהה הייחודי של החשבון.
test_account מחרוזת $.attributes.test_account מציין אם זהו חשבון בדיקה.
default_sender_name מחרוזת $.attributes.contact_information.default_sender_name שם ברירת המחדל שמופיע כשם השולח באימיילים.
default_sender_email מחרוזת $.attributes.contact_information.default_sender_email כתובת האימייל שמוגדרת כברירת מחדל לשליחת אימיילים.
website_url מחרוזת $.attributes.contact_information.website_url כתובת ה-URL של אתר הארגון.
organization_name מחרוזת $.attributes.contact_information.organization_name שם הארגון.
address1 מחרוזת $.attributes.contact_information.street_address.address1 שורת רחוב 1.
address2 מחרוזת $.attributes.contact_information.street_address.address2 שורת רחוב 2.
city מחרוזת $.attributes.contact_information.street_address.city העיר שבה נמצא הארגון.
region מחרוזת $.attributes.contact_information.street_address.region מדינה (State), מחוז או אזור.
country מחרוזת $.attributes.contact_information.street_address.country מדינה.
zip מחרוזת $.attributes.contact_information.street_address.zip מיקוד.
industry מחרוזת $.attributes.industry הענף של החשבון.
timezone מחרוזת $.attributes.timezone הגדרת אזור הזמן של החשבון.
preferred_currency מחרוזת $.attributes.preferred_currency המטבע הראשי שמוגדר בחשבון.
public_api_key מחרוזת $.attributes.public_api_key מפתח API ציבורי (מזהה אתר) לשילובים בצד הלקוח.
locale מחרוזת $.attributes.locale הגדרת הלוקאל (למשל, en-US).

שוברים

שוברים להנחות ומבצעים.

  • שם הטבלה: שוברים
  • נקודת קצה: /coupons
  • מאמרי העזרה של Klaviyo API: Get Coupons
שם השדה סוג נתיב JSON תיאור
type מחרוזת $.type סוג המשאב (תמיד coupon).
id מחרוזת $.id מזהה פנימי ייחודי של השובר.
external_id מחרוזת $.attributes.external_id מזהה חיצוני (בדרך כלל זהה לשם או למזהה).
description מחרוזת $.attributes.description תיאור של מבצע השובר.
low_balance_threshold מחרוזת $.attributes.monitor_configuration.low_balance_threshold הסף להפעלת התראות על יתרה נמוכה.

CouponCode

קודים ייחודיים שנוצרו לשוברים ספציפיים.

שם השדה סוג נתיב JSON תיאור
type מחרוזת $.type סוג המשאב (תמיד coupon-code).
id מחרוזת $.id מזהה ייחודי למופע הספציפי הזה של הקוד.
unique_code מחרוזת $.attributes.unique_code מחרוזת הקוד האלפאנומרי בפועל.
expires_at TIMESTAMP $.attributes.expires_at חותמת זמן של מועד פקיעת התוקף של הקוד.
status מחרוזת $.attributes.status סטטוס הקוד (למשל, ASSIGNED, ‏ UNASSIGNED).
coupon_id מחרוזת $.relationships.coupon.data.id המזהה של הגדרת השובר הראשית.

אירועים

אירועי פעילות שמתבצע אחריהם מעקב בפרופילים (למשל, ביצוע הזמנה, צפייה במוצר).

  • שם הטבלה: Events
  • נקודת קצה: /events
  • מאמרי העזרה של ה-API של Klaviyo: Get Events
שם השדה סוג נתיב JSON תיאור
type מחרוזת $.type סוג המשאב (תמיד event).
id מחרוזת $.id המזהה הייחודי של האירוע.
timestamp FLOAT $.attributes.timestamp חותמת זמן של מערכת Unix של מועד התרחשות האירוע.
event_properties JSON $.attributes.event_properties מאפייני JSON מותאמים אישית שספציפיים לסוג האירוע (למשל, פריטים בהזמנה).
datetime TIMESTAMP $.attributes.datetime חותמת זמן של האירוע לפי תקן ISO 8601.
uuid מחרוזת $.attributes.uuid מזהה ייחודי אוניברסלי של האירוע.
profile_id מחרוזת $.relationships.profile.data.id מזהה הפרופיל (הלקוח) שמשויך לאירוע.
metric_id מחרוזת $.relationships.metric.data.id המזהה של הגדרת המדד (סוג האירוע).
attribution_ids מחרוזת חוזרת $.relationships.attributions.data[*].id מזהי הקמפיינים או התהליכים שמשויכים לאירוע הזה.

תהליכים

תהליכי שיווק אוטומטיים שמופעלים על ידי אירועים או תנאים ספציפיים.

  • שם הטבלה: תהליכים
  • נקודת קצה: /flows
  • מאמרי העזרה של Klaviyo API: Get Flows
שם השדה סוג נתיב JSON תיאור
type מחרוזת $.type סוג המשאב (תמיד flow).
id מחרוזת $.id המזהה הייחודי של התהליך.
name מחרוזת $.attributes.name שם התהליך.
status מחרוזת $.attributes.status סטטוס פעילות (למשל, פעיל, טיוטה).
archived בוליאני $.attributes.archived אם התהליך הועבר לארכיון.
created TIMESTAMP $.attributes.created חותמת הזמן של היצירה.
updated TIMESTAMP $.attributes.updated חותמת הזמן של השינוי האחרון.
trigger_type מחרוזת $.attributes.trigger_type המנגנון שמפעיל את התהליך (למשל, "נוסף לרשימה", "מדד").
flow_actions_ids מחרוזת חוזרת $.relationships.flow-actions.data[*].id המזהים של הפעולות (השלבים) בתהליך הזה.
tag_ids מחרוזת חוזרת $.relationships.tags.data[*].id מזהי התגים שהוקצו לתהליך הזה.

Forms

טופסי הרשמה לאיסוף פרטי מנויים.

  • שם הטבלה: טפסים
  • נקודת קצה: /forms
  • מאמרי העזרה של ה-API של Klaviyo: Get Forms
שם השדה סוג נתיב JSON תיאור
type מחרוזת $.type סוג המשאב (תמיד form).
id מחרוזת $.id המזהה הייחודי של הטופס.
name מחרוזת $.attributes.name שם הטופס.
status מחרוזת $.attributes.status סטטוס הטופס (למשל, פעיל, טיוטה).
ab_test בוליאני $.attributes.ab_test אם מתבצעת בדיקת A/B בטופס.
created_at TIMESTAMP $.attributes.created_at חותמת הזמן של היצירה.
updated_at TIMESTAMP $.attributes.updated_at חותמת הזמן של השינוי האחרון.

תמונות

תמונות שהועלו ל-Klaviyo לשימוש בקמפיינים ובתבניות.

  • שם הטבלה: Images
  • נקודת קצה: /images
  • מאמרי העזרה של ה-API של Klaviyo: Get Images
שם השדה סוג נתיב JSON תיאור
type מחרוזת $.type סוג המשאב (תמיד image).
id מחרוזת $.id מזהה ייחודי.
name מחרוזת $.attributes.name שם הקובץ או שם התמונה.
image_url מחרוזת $.attributes.image_url כתובת URL ציבורית לגישה לתמונה.
format מחרוזת $.attributes.format פורמט קובץ התמונה (למשל, jpeg, ‏ png).
size FLOAT $.attributes.size גודל הקובץ בבייטים.
hidden בוליאני $.attributes.hidden אם התמונה מוסתרת בממשק המשתמש.
updated_at TIMESTAMP $.attributes.updated_at חותמת הזמן של השינוי האחרון.

רשימות

רשימות סטטיות של אנשי קשר או פרופילים.

  • שם הטבלה: רשימות
  • נקודת קצה: /lists
  • מאמרי העזרה של Klaviyo API: Get Lists
שם השדה סוג נתיב JSON תיאור
type מחרוזת $.type סוג המשאב (תמיד list).
id מחרוזת $.id המזהה הייחודי של הרשימה.
name מחרוזת $.attributes.name השם של רשימת אנשי הקשר.
created TIMESTAMP $.attributes.created חותמת הזמן של היצירה.
updated TIMESTAMP $.attributes.updated חותמת הזמן של השינוי האחרון.
opt_in_process מחרוזת $.attributes.opt_in_process הגדרת ההצטרפות (למשל, "singleoptin" או "doubleoptin").
tag_ids מחרוזת חוזרת $.relationships.tags.data[*].id מזהי התגים שהוקצו לרשימה הזו.
flow_triggers_ids מחרוזת חוזרת $.relationships.flow-triggers.data[*].id מזהים של תהליכים שמופעלים כשמוסיפים פרופילים לרשימה הזו.

מדדים

סוגי האירועים שאפשר לעקוב אחריהם (למשל, "התקבל אימייל").

  • שם הטבלה: מדדים
  • נקודת קצה: /metrics
  • ‫Klaviyo API reference: Get Metrics
שם השדה סוג נתיב JSON תיאור
type מחרוזת $.type סוג המשאב (תמיד metric).
id מחרוזת $.id מזהה ייחודי (למשל, קוד בן 6 תווים למזהה גנרי, UUID ארוך למזהה בהתאמה אישית).
name מחרוזת $.attributes.name שם קריא לאנשים (למשל, "הזמנה בוצעה").
created TIMESTAMP $.attributes.created חותמת הזמן של היצירה.
updated TIMESTAMP $.attributes.updated חותמת הזמן של השינוי האחרון.
integration JSON $.attributes.integration מידע על השילוב שמספק את המדד הזה (למשל: שם, קטגוריה, תמונה).
flow_triggers_ids מחרוזת חוזרת $.relationships.flow-triggers.data[*].id מזהים של תהליכים שהופעלו על ידי המדד הזה.

פרופילים

פרופילים מקיפים של לקוחות שכוללים מאפיינים והיסטוריית פעילות.

  • שם הטבלה: Profiles
  • נקודת קצה: /profiles
  • מאמרי העזרה של Klaviyo API: Get Profiles
שם השדה סוג נתיב JSON תיאור
type מחרוזת $.type סוג המשאב (תמיד profile).
id מחרוזת $.id מזהה Klaviyo ייחודי לפרופיל.
email מחרוזת $.attributes.email כתובת אימייל ראשית.
phone_number מחרוזת $.attributes.phone_number מספר טלפון בפורמט E.164.
external_id מחרוזת $.attributes.external_id מזהה ממערכת חיצונית.
first_name מחרוזת $.attributes.first_name שם פרטי.
last_name מחרוזת $.attributes.last_name שם משפחה.
organization מחרוזת $.attributes.organization שם החברה או הארגון.
locale מחרוזת $.attributes.locale הגדרת הלוקאל/השפה.
title מחרוזת $.attributes.title תפקיד.
image מחרוזת $.attributes.image כתובת ה-URL של תמונת הפרופיל.
created TIMESTAMP $.attributes.created חותמת הזמן של יצירת הפרופיל.
updated TIMESTAMP $.attributes.updated חותמת הזמן של העדכון האחרון.
last_event_date TIMESTAMP $.attributes.last_event_date חותמת הזמן של האירוע האחרון.
address1 מחרוזת $.attributes.location.address1 שורת כתובת 1.
address2 מחרוזת $.attributes.location.address2 שורת כתובת 2.
city מחרוזת $.attributes.location.city עיר.
country מחרוזת $.attributes.location.country מדינה.
latitude מחרוזת $.attributes.location.latitude קואורדינטות של קו הרוחב.
longitude מחרוזת $.attributes.location.longitude קואורדינטות של קו האורך.
region מחרוזת $.attributes.location.region מדינה או אזור.
zip מחרוזת $.attributes.location.zip מיקוד.
timezone מחרוזת $.attributes.location.timezone אזור זמן.
ip מחרוזת $.attributes.location.ip כתובת IP.
properties JSON $.attributes.properties צמדי מפתח/ערך של מאפיינים מותאמים אישית.
email_marketing_can_receive_email_marketing בוליאני $.attributes.subscriptions.email.marketing.can_receive_email_marketing האם הפרופיל יכול לקבל שיווק באימייל.
email_marketing_consent מחרוזת $.attributes.subscriptions.email.marketing.consent סטטוס ההסכמה (למשל, SUBSCRIBED, ‏ UNSUBSCRIBED).
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 מחרוזת $.attributes.subscriptions.email.marketing.method שיטת ההסכמה (למשל, FORM).
email_marketing_method_detail מחרוזת $.attributes.subscriptions.email.marketing.method_detail מקור ספציפי של שיטה.
email_marketing_custom_method_detail מחרוזת $.attributes.subscriptions.email.marketing.custom_method_detail פרטים בהתאמה אישית על שיטת ההסכמה.
email_marketing_double_optin בוליאני $.attributes.subscriptions.email.marketing.double_optin האם הושלמה הרשמה בשני שלבים.
sms_marketing_can_receive_sms_marketing בוליאני $.attributes.subscriptions.sms.marketing.can_receive_sms_marketing אם הפרופיל יכול לקבל הודעות SMS שיווקיות.
sms_marketing_consent מחרוזת $.attributes.subscriptions.sms.marketing.consent סטטוס ההסכמה לקבלת הודעות SMS.
sms_marketing_consent_timestamp TIMESTAMP $.attributes.subscriptions.sms.marketing.consent_timestamp מתי ניתנה ההסכמה לקבלת הודעות SMS.
sms_marketing_last_updated TIMESTAMP $.attributes.subscriptions.sms.marketing.last_updated מתי ההסכמה לקבלת הודעות SMS עודכנה בפעם האחרונה.
sms_marketing_method מחרוזת $.attributes.subscriptions.sms.marketing.method שיטת ההסכמה ל-SMS.
sms_marketing_method_detail מחרוזת $.attributes.subscriptions.sms.marketing.method_detail פרטים על שיטת ההסכמה ל-SMS.
sms_transactional_can_receive_sms_transactional בוליאני $.attributes.subscriptions.sms.transactional.can_receive_sms_transactional אם הפרופיל יכול לקבל הודעות SMS שקשורות לעסקאות.
sms_transactional_consent מחרוזת $.attributes.subscriptions.sms.transactional.consent סטטוס ההסכמה לקבלת הודעות SMS בנושא עסקאות.
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 מחרוזת $.attributes.subscriptions.sms.transactional.method שיטת SMS לביצוע פעולות.
sms_transactional_method_detail מחרוזת $.attributes.subscriptions.sms.transactional.method_detail פרטי השיטה של SMS טרנזקציונלי.
mobile_push_can_receive_push_marketing בוליאני $.attributes.subscriptions.mobile_push.marketing.can_receive_push_marketing אם הפרופיל יכול לקבל שיווק בהתראות.
mobile_push_consent מחרוזת $.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 ערך הלקוח לטווח הארוך (CLV) ההיסטורי.
predictive_analytics_predicted_clv FLOAT $.attributes.predictive_analytics.predicted_clv ערך הלקוח החזוי לטווח הארוך (pCLV).
predictive_analytics_total_clv FLOAT $.attributes.predictive_analytics.total_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 מחרוזת חוזרת $.relationships.push-tokens.data[*].id מזהי טוקנים משויכים של התראות.

ביקורות

ביקורות על מוצרים שנשלחו על ידי לקוחות.

  • שם הטבלה: ביקורות
  • נקודת קצה: /reviews
  • מאמרי העזרה של ה-API של Klaviyo: קבלת ביקורות
שם השדה סוג נתיב JSON תיאור
type מחרוזת $.type סוג המשאב (תמיד review).
id מחרוזת $.id המזהה הייחודי של הביקורת.
email מחרוזת $.attributes.email כתובת האימייל של הבודק.
value מחרוזת $.attributes.status.value ערך הסטטוס (למשל, פורסם, נדחה).
reason מחרוזת $.attributes.status.rejection_reason.reason הסיבה לדחייה, אם רלוונטי.
status_explanation מחרוזת $.attributes.status.rejection_reason.status_explanation הסבר מפורט על הסטטוס.
verified בוליאני $.attributes.verified אם הרכישה אומתה.
review_type מחרוזת $.attributes.review_type סוג הביקורת (למשל, ביקורת על מוצר).
created TIMESTAMP $.attributes.created חותמת הזמן של היצירה.
updated TIMESTAMP $.attributes.updated חותמת הזמן של השינוי האחרון.
images מחרוזת חוזרת $.attributes.images[*] כתובות ה-URL של התמונות שצורפו לביקורת.
product_url מחרוזת $.attributes.product.url כתובת ה-URL של המוצר שנוספה לו ביקורת.
product_name מחרוזת $.attributes.product.name שם המוצר.
product_image_url מחרוזת $.attributes.product.image_url כתובת ה-URL של תמונת המוצר.
product_external_id מחרוזת $.attributes.product.external_id המזהה החיצוני של המוצר.
rating מספר שלם $.attributes.rating ציון הדירוג.
author מחרוזת $.attributes.author השם של כותב הביקורת.
content מחרוזת $.attributes.content תוכן הטקסט של הביקורת.
title מחרוזת $.attributes.title כותרת הביקורת.
smart_quote מחרוזת $.attributes.smart_quote ציטוט מודגש מהביקורת.
public_reply_content מחרוזת $.attributes.public_reply.content תוכן התגובה הגלויה לכולם של המוכר.
public_reply_author מחרוזת $.attributes.public_reply.author המחבר של התשובה.
public_reply_updated מחרוזת $.attributes.public_reply.updated חותמת הזמן של עדכון התשובה.
event_ids מחרוזת חוזרת $.relationships.events.data[*].id מזהי האירועים המשויכים.

פלחים

קבוצות דינמיות של פרופילים שמבוססות על קריטריונים ספציפיים.

  • שם הטבלה: פלחים
  • נקודת קצה: /segments
  • מאמרי העזרה של Klaviyo API: Get Segments
שם השדה סוג נתיב JSON תיאור
type מחרוזת $.type סוג המשאב (תמיד segment).
id מחרוזת $.id המזהה הייחודי של הפלח.
name מחרוזת $.attributes.name שם הפלח.
created TIMESTAMP $.attributes.created חותמת הזמן של היצירה.
updated TIMESTAMP $.attributes.updated חותמת הזמן של השינוי האחרון.
is_active בוליאני $.attributes.is_active אם הפלח פעיל.
is_processing בוליאני $.attributes.is_processing אם הפלח נמצא בתהליך עיבוד.
is_starred בוליאני $.attributes.is_starred אם הקטע מסומן בכוכב או כמועדף.
tag_ids מחרוזת חוזרת $.relationships.tags.data[*].id מזהים של תגים משויכים.
flow_triggers_ids מחרוזת חוזרת $.relationships.flow-triggers.data[*].id מזהי התהליכים שהופעלו על ידי הפלח הזה.
condition_groups REPEATED ConditionGroup $.attributes.definition.condition_groups[*] קבוצות של תנאים לוגיים שמגדירים את הפלח.

ConditionGroup

שם השדה סוג נתיב JSON תיאור
conditions תנאי REPEATED conditions[*] רשימה של תנאים נפרדים בקבוצה.

תנאי

שם השדה סוג נתיב JSON תיאור
type מחרוזת type סוג התנאי (למשל, profile-property).
value JSON N/A ערך/הגדרה של תנאי.

תגים

תגים שמשמשים לארגון קמפיינים, תהליכים ורשימות.

  • שם הטבלה: Tags
  • נקודת קצה: /tags
  • מאמרי העזרה של Klaviyo API: Get Tags
שם השדה סוג נתיב JSON תיאור
type מחרוזת $.type סוג המשאב (תמיד tag).
id מחרוזת $.id מזהה ייחודי של התג.
name מחרוזת $.attributes.name שם התג.
tag_group_id מחרוזת $.relationships.tag-group.data.id המזהה של קבוצת התגים שהתג הזה שייך אליה.

תבניות

תבניות של אימיילים והודעות.

  • שם הטבלה: Templates
  • נקודת קצה: /templates
  • מאמרי העזרה של ה-API של Klaviyo: Get Templates
שם השדה סוג נתיב JSON תיאור
type מחרוזת $.type סוג המשאב (תמיד template).
id מחרוזת $.id מזהה ייחודי.
name מחרוזת $.attributes.name שם התבנית.
editor_type מחרוזת $.attributes.editor_type העורך שבו השתמשתם (למשל, גרירה ושחרור).
html מחרוזת $.attributes.html תוכן HTML
text מחרוזת $.attributes.text גרסת הטקסט של התבנית.
amp מחרוזת $.attributes.amp גרסת AMP של התבנית.
created TIMESTAMP $.attributes.created חותמת הזמן של היצירה.
updated TIMESTAMP $.attributes.updated חותמת הזמן של העדכון האחרון.

WebFeeds

פידים באינטרנט שמשמשים לאכלוס תוכן בהודעות.

  • שם הטבלה: WebFeeds
  • נקודת קצה: /web-feeds
  • מאמרי העזרה של ה-API של Klaviyo: Get Web Feeds
שם השדה סוג נתיב JSON תיאור
type מחרוזת $.type סוג המשאב (תמיד web-feed).
id מחרוזת $.id מזהה ייחודי.
name מחרוזת $.attributes.name שם הפיד.
url מחרוזת $.attributes.url כתובת ה-URL של מקור הפיד.
request_method מחרוזת $.attributes.request_method שיטת HTTP‏ (GET/POST).
content_type מחרוזת $.attributes.content_type סוג התוכן (למשל, JSON).
status מחרוזת $.attributes.status סטטוס הפיד.
created TIMESTAMP $.attributes.created חותמת הזמן של היצירה.
updated TIMESTAMP $.attributes.updated חותמת הזמן של העדכון האחרון.

DataSources

מקורות נתונים שמשולבים ב-Klaviyo.

שם השדה סוג נתיב JSON תיאור
type מחרוזת $.type סוג המשאב (תמיד data-source).
id מחרוזת $.id מזהה ייחודי.
title מחרוזת $.attributes.title השם של מקור הנתונים.
visibility מחרוזת $.attributes.visibility רמת החשיפה.
description מחרוזת $.attributes.description טקסט תיאור.

קמפיינים

קמפיינים שיווקיים שנשלחים לרשימות או לפלחים.

  • שם הטבלה: קמפיינים
  • נקודת קצה: /campaigns
  • מאמרי העזרה של Klaviyo API: Get Campaigns
שם השדה סוג נתיב JSON תיאור
type מחרוזת $.type סוג המשאב (תמיד campaign).
id מחרוזת $.id מזהה ייחודי.
name מחרוזת $.attributes.name שם הקמפיין.
status מחרוזת $.attributes.status סטטוס הקמפיין (למשל, נשלח, בתזמון).
archived בוליאני $.attributes.archived אם הקמפיין הועבר לארכיון.
included מחרוזת חוזרת $.attributes.audiences.included מזהים של רשימות או פלחים שנכללים.
excluded מחרוזת חוזרת $.attributes.audiences.excluded מזהים של רשימות החרגות או פלחים.
send_options JSON $.attributes.send_options הגדרות השליחה (למשל, שליחה חכמה).
tracking_options JSON $.attributes.tracking_options הגדרות למעקב (למשל, פרמטרים של UTM).
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 מחרוזת חוזרת $.relationships.tags.data[*].id מזהים של תגים משויכים.
campaign_message_ids מחרוזת חוזרת $.relationships.campaign-messages.data[*].id המזהים של ההודעות שכלולות בקמפיין הזה.

CampaignMessages

הודעות נפרדות (אימייל או SMS) בקמפיין.

  • שם הטבלה: CampaignMessages
  • נקודת קצה: /campaign-messages
  • מאמרי העזרה של ה-API של Klaviyo: Get Campaign Message
שם השדה סוג נתיב JSON תיאור
type מחרוזת $.type סוג המשאב (תמיד campaign-message).
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 מחרוזת $.relationships.campaign.data.id המזהה של קמפיין ההורה.
template_id מחרוזת $.relationships.template.data.id מזהה התבנית שבה השתמשתם.
image_id מחרוזת $.relationships.image.data.id המזהה של התמונה המצורפת.

קטגוריות

קטגוריות מוצרים מהקטלוג שלכם.

  • שם הטבלה: Categories
  • נקודת קצה: /catalog-categories
  • מאמרי העזרה של Klaviyo API: Get Catalog Categories
שם השדה סוג נתיב JSON תיאור
type מחרוזת $.type סוג המשאב.
id מחרוזת $.id מזהה ייחודי.
name מחרוזת $.attributes.name שם הקטגוריה.
external_id מחרוזת $.attributes.external_id מזהה מערכת חיצוני.
updated TIMESTAMP $.attributes.updated חותמת הזמן של העדכון האחרון.

פריטים

מוצרים או פריטים ספציפיים בקטלוג.

  • שם הטבלה: פריטים
  • נקודת קצה: /catalog-items
  • מאמרי העזרה של ה-API של Klaviyo: Get Catalog Items
שם השדה סוג נתיב JSON תיאור
type מחרוזת $.type סוג המשאב.
id מחרוזת $.id מזהה ייחודי.
external_id מחרוזת $.attributes.external_id מזהה מערכת חיצונית.
title מחרוזת $.attributes.title שם הפריט.
description מחרוזת $.attributes.description יש תיאור.
price FLOAT $.attributes.price מחיר הפריט.
url מחרוזת $.attributes.url כתובת ה-URL של הפריט.
image_full_url מחרוזת $.attributes.image_full_url כתובת ה-URL של התמונה בגודל מלא.
image_thumbnail_url מחרוזת $.attributes.image_thumbnail_url כתובת ה-URL של התמונה הממוזערת.
images מחרוזת חוזרת $.attributes.images[*] רשימה של כתובות URL של תמונות נוספות.
custom_metadata JSON $.attributes.custom_metadata ערכי מפתח של מטא-נתונים בהתאמה אישית.
published בוליאני $.attributes.published סטטוס הפרסום.
created TIMESTAMP $.attributes.created חותמת הזמן של היצירה.
updated TIMESTAMP $.attributes.updated חותמת הזמן של העדכון האחרון.
variants_ids מחרוזת חוזרת $.relationships.variants.data[*].id מזהי הווריאציות של הפריט הזה.

וריאנטים

וריאציות ספציפיות של פריטים בקטלוג (למשל, מידות, צבעים).

  • שם הטבלה: Variants
  • נקודת קצה: /catalog-variants
  • מאמרי העזרה של ה-API של Klaviyo: Get Catalog Variants
שם השדה סוג נתיב JSON תיאור
type מחרוזת $.type סוג המשאב.
id מחרוזת $.id מזהה ייחודי.
external_id מחרוזת $.attributes.external_id מזהה מערכת חיצונית.
title מחרוזת $.attributes.title שם הווריאציה.
description מחרוזת $.attributes.description יש תיאור.
sku מחרוזת $.attributes.sku מספר קטלוגי (SKU).
inventory_policy FLOAT $.attributes.inventory_policy המדיניות בנושא ניהול מלאי שטחי פרסום.
inventory_quantity FLOAT $.attributes.inventory_quantity כמות המלאי הנוכחית.
price FLOAT $.attributes.price מחיר.
url מחרוזת $.attributes.url כתובת ה-URL של הווריאציה.
image_full_url מחרוזת $.attributes.image_full_url כתובת ה-URL המלאה של התמונה זמינה (ערך בוליאני).
image_thumbnail_url מחרוזת $.attributes.image_thumbnail_url כתובת ה-URL של התמונה הממוזערת.
images מחרוזת חוזרת $.attributes.images[*] רשימת תמונות.
published בוליאני $.attributes.published סטטוס הפרסום.
created TIMESTAMP $.attributes.created חותמת הזמן של היצירה.
updated TIMESTAMP $.attributes.updated חותמת הזמן של העדכון האחרון.

FlowActions

פעולות שמשויכות לתהליך.

  • שם הטבלה: FlowActions
  • נקודת קצה: /flows/{id}/flow-actions
  • מאמרי העזרה של Klaviyo API: Get Flow Actions
שם השדה סוג נתיב JSON תיאור
type מחרוזת $.type סוג המשאב. תמיד flow-action.
id מחרוזת $.id המזהה הייחודי של הפעולה בתהליך.
created TIMESTAMP $.attributes.created חותמת הזמן של היצירה.
updated TIMESTAMP $.attributes.updated חותמת הזמן של השינוי האחרון.
message_id מחרוזת $.attributes.definition.id המזהה הייחודי של הגדרת הודעת הפעולה.
message_temporary_id מחרוזת $.attributes.definition.temporary_id מזהה זמני שמוקצה להגדרת ההודעה.
message_type מחרוזת $.attributes.definition.type סוג ההודעה, למשל email, sms.
condition_groups REPEATED ConditionGroup $.attributes.definition.data.action_output_filter.condition_groups[*] תנאים שמשויכים למסנן הפלט של פעולת התהליך.
next_if_true מחרוזת $.attributes.definition.links.next_if_true המזהה של הפעולה הבאה בתהליך אם התנאי מקבל את הערך true.
next_if_false מחרוזת $.attributes.definition.links.next_if_false מזהה הפעולה הבאה בתהליך אם התנאי מקבל את הערך false.

FormVersions

גרסאות של טופס מסוים.

  • שם הטבלה: FormVersions
  • נקודת קצה: /forms/{id}/form-versions
  • מאמרי העזרה של ה-API של Klaviyo: Get Form Versions
שם השדה סוג נתיב JSON תיאור
type מחרוזת $.type סוג המשאב. תמיד form-version.
id מחרוזת $.id המזהה הייחודי של גרסת הטופס.
form_type מחרוזת $.attributes.form_type סוג הטופס, למשל popup,‏ embed,‏ banner.
variation_name מחרוזת $.attributes.variation_name השם של וריאציית הטופס.
ab_test JSON $.attributes.ab_test הגדרות של בדיקת A/B והגדרות של וריאציות.
status מחרוזת $.attributes.status הסטטוס התפעולי של גרסת הטופס, למשל draft, live.
created_at TIMESTAMP $.attributes.created_at חותמת הזמן של היצירה.
updated_at TIMESTAMP $.attributes.updated_at חותמת הזמן של השינוי האחרון.

PushTokens

אסימוני התראות שמשויכים לפרופילים של אפליקציות לנייד לצורך שליחת התראות.

שם השדה סוג נתיב JSON תיאור
type מחרוזת $.type סוג המשאב. תמיד push-token.
id מחרוזת $.id מזהה ייחודי של טוקן ההתראה.
created TIMESTAMP $.attributes.created חותמת הזמן של היצירה.
token מחרוזת $.attributes.token מחרוזת של טוקן להתראות במכשיר.
enablement_status מחרוזת $.attributes.enablement_status סטטוס ההפעלה של התראות, כמו AUTHORIZED, UNAUTHORIZED.
platform מחרוזת $.attributes.platform פלטפורמה לנייד, כמו ios,‏ android.
vendor מחרוזת $.attributes.vendor ספק שירות, כמו apns, fcm.
background מחרוזת $.attributes.background סטטוס הרענון ברקע של התראות.
recorded_date TIMESTAMP $.attributes.recorded_date התאריך שבו נרשם טוקן ההתראה.
metadata JSON $.attributes.metadata מטא-נתונים בהתאמה אישית של מכשיר או של אסימון התראות.
profile_id מחרוזת $.relationships.profile.data.id המזהה של פרופיל הלקוח שמשויך לטוקן הזה של ההתראות.

TagGroups

קבוצות של תגים משמשות לארגון ולסיווג של תגים.

  • שם הטבלה: TagGroups
  • נקודת קצה: /tag-groups
  • מאמרי העזרה של ה-API של Klaviyo: Get Tag Groups
שם השדה סוג נתיב JSON תיאור
type מחרוזת $.type סוג המשאב. תמיד tag-group.
id מחרוזת $.id המזהה הייחודי של קבוצת התגים.
name מחרוזת $.attributes.name השם של קבוצת התגים.
exclusive בוליאני $.attributes.exclusive אם התגים בקבוצה הזו הם בלעדיים הדדית.
default בוליאני $.attributes.default האם זו קבוצת התגים שמוגדרת כברירת מחדל בחשבון.

UniversalContent

אבני בניין אוניברסליות לשימוש חוזר בתוכן של הודעות ותבניות.

  • שם הטבלה: UniversalContent
  • נקודת קצה: /template-universal-content
  • מאמרי העזרה של ה-API של Klaviyo: Get Universal Content
שם השדה סוג נתיב JSON תיאור
type מחרוזת $.type סוג המשאב. תמיד template-universal-content.
id מחרוזת $.id המזהה הייחודי של בלוק התוכן האוניברסלי.
name מחרוזת $.attributes.name השם של קטע התוכן האוניברסלי.
definition_content_type מחרוזת $.attributes.definition.content_type סוג התוכן של ההגדרה, למשל block, template.
definition_type מחרוזת $.attributes.definition.type סוג הרכיב של התוכן, למשל text,‏ button,‏ image.
definition_data JSON $.attributes.definition.data נתונים מבניים ומטען ייעודי (payload) של הגדרת התוכן.
created TIMESTAMP $.attributes.created חותמת הזמן של היצירה.
updated TIMESTAMP $.attributes.updated חותמת הזמן של השינוי האחרון.
screenshot_status מחרוזת $.attributes.screenshot_status סטטוס היצירה של צילום המסך לתצוגה מקדימה, למשל completed, pending.
screenshot_url מחרוזת $.attributes.screenshot_url כתובת URL ציבורית של צילום המסך של התצוגה המקדימה של התוכן.

MetricProperties

מאפיינים ומאפיינים מבניים שמוגדרים למדדים ספציפיים.

  • שם הטבלה: MetricProperties
  • נקודת קצה: /metrics/{id}/metric-properties
  • מאמרי העזרה של ה-API של Klaviyo: Get Metric Properties
שם השדה סוג נתיב JSON תיאור
type מחרוזת $.type סוג המשאב. תמיד metric-property.
id מחרוזת $.id המזהה הייחודי של מאפיין המדד.
sample_values JSON $.attributes.sample_values ערכי נתונים לדוגמה שתועדו במאפיין המדד הזה.
label מחרוזת $.attributes.label תווית קריאה לאנשים של הנכס.
property מחרוזת $.attributes.property שם המפתח של מאפיין האירוע.
inferred_type מחרוזת $.attributes.inferred_type סוג הנתונים ש-Klaviyo מסיקה לגבי המאפיין הזה, כמו string,‏ boolean,‏ numeric.
metric_id מחרוזת $.relationships.metric.data.id המזהה של הגדרת המדד הראשי.

TrackingSettings

פרמטרים של מעקב UTM ברמת החשבון לקמפיינים ולתהליכים.

  • שם הטבלה: TrackingSettings
  • נקודת קצה: /tracking-settings
  • מאמרי העזרה של Klaviyo API: Get Tracking Settings
שם השדה סוג נתיב JSON תיאור
type מחרוזת $.type סוג המשאב. תמיד tracking-setting.
id מחרוזת $.id מזהה ייחודי של הגדרות המעקב.
auto_add_parameters בוליאני $.attributes.auto_add_parameters אם פרמטרים של מנטר התנועה של Urchin מתווספים באופן אוטומטי לקישורים בהודעות.
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 הקשר של הגדרות הפרמטרים של מנטר התנועה של Urchin לתהליכים.
campaign ParameterContext campaign הקשר של הגדרות פרמטרים של מנטר התנועה של Urchin בקמפיינים.

ParameterContext

שם השדה סוג נתיב JSON תיאור
type מחרוזת type סוג המשאב.
value מחרוזת value ערך של תבנית פרמטר או מפתח מאפיין, כמו emailsubject, campaignid.

CustomParameter

שם השדה סוג נתיב JSON תיאור
flow ParameterContext flow הקשר של פרמטר מעקב מותאם אישית לתהליכים.
campaign ParameterContext campaign הקשר של פרמטר מעקב מותאם אישית לקמפיינים.
name מחרוזת name השם של פרמטר המעקב המותאם אישית.