מאמר עזר בנושא מודל הנתונים של 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
- נקודת קצה:
/coupons - הפניית API של Klaviyo: 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
קודים ייחודיים נפרדים שנוצרים לקופונים ספציפיים.
- שם הטבלה: CouponCode
- נקודת קצה:
/coupon-codes - הפניית API של Klaviyo: Get Coupon Codes
| שם השדה | סוג | נתיב JSON | תיאור |
|---|---|---|---|
type |
מחרוזת | $.type |
סוג המשאב (תמיד coupon-code). |
id |
מחרוזת | $.id |
מזהה ייחודי של מופע הקוד הספציפי הזה. |
unique_code |
מחרוזת | $.attributes.unique_code |
מחרוזת הקוד האלפאנומרי בפועל. |
expires_at |
TIMESTAMP | $.attributes.expires_at |
חותמת זמן של מועד התפוגה של הקוד. |
status |
מחרוזת | $.attributes.status |
סטטוס הקוד (למשל, הוקצו, לא הוקצו). |
coupon_id |
מחרוזת | $.relationships.coupon.data.id |
המזהה של הגדרת השובר הראשי. |
אירועים
אירועי פעילות שנרשמים בפרופילים (למשל, הזמנה שבוצעה, מוצר שנצפה).
- שם הטבלה: Events
- נקודת קצה:
/events - הפניית Klaviyo API: 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 |
REPEATED STRING | $.relationships.attributions.data[*].id |
מזהים של קמפיינים או תהליכים שמשויכים לאירוע הזה. |
Flows
תהליכי שיווק אוטומטיים שמופעלים על ידי אירועים או תנאים ספציפיים.
- שם הטבלה: Flows
- נקודת קצה:
/flows - הפניית API של Klaviyo: 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 |
המנגנון שמפעיל את התהליך (למשל, 'Added to List' (נוסף לרשימה), 'Metric' (מדד). |
flow_actions_ids |
REPEATED STRING | $.relationships.flow-actions.data[*].id |
מזהים של הפעולות (השלבים) בתהליך הזה. |
tag_ids |
REPEATED STRING | $.relationships.tags.data[*].id |
מזהי התוויות שהוקצו לתהליך הזה. |
Forms
טפסים להרשמה שמאפשרים לאסוף פרטי מנויים.
- שם הטבלה: 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 - הפניית API של Klaviyo: 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 |
הגדרת הצטרפות (למשל, 'single_opt_in' או 'double_opt_in'). |
tag_ids |
REPEATED STRING | $.relationships.tags.data[*].id |
מזהים של התוויות שהוקצו לרשימה הזו. |
flow_triggers_ids |
REPEATED STRING | $.relationships.flow-triggers.data[*].id |
מזהים של תהליכים שהופעלו על ידי הוספת פרופילים לרשימה הזו. |
מדדים
סוגי האירועים שאפשר לעקוב אחריהם (למשל, 'Received Email').
- שם הטבלה: Metrics
- נקודת קצה:
/metrics - הפניית API של Klaviyo: Get Metrics
| שם השדה | סוג | נתיב JSON | תיאור |
|---|---|---|---|
type |
מחרוזת | $.type |
סוג המשאב (תמיד metric). |
id |
מחרוזת | $.id |
מזהה ייחודי (למשל, קוד בן 6 תווים למזהה ייחודי אוניברסלי (UUID) כללי וארוך למזהה ייחודי אוניברסלי (UUID) מותאם אישית). |
name |
מחרוזת | $.attributes.name |
שם קריא לאנשים (למשל, 'הזמנה שבוצעה'). |
created |
TIMESTAMP | $.attributes.created |
חותמת הזמן של היצירה. |
updated |
TIMESTAMP | $.attributes.updated |
חותמת הזמן של השינוי האחרון. |
integration |
JSON | $.attributes.integration |
מידע על השילוב שמספק את המדד הזה (למשל, שם, קטגוריה, תמונה). |
flow_triggers_ids |
REPEATED STRING | $.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 |
סטטוס ההסכמה (למשל, רשום כמנוי, לא רשום כמנוי). |
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 |
צפי של ערך הלקוח לטווח הארוך (CLV). |
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 |
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 |
מזהי טוקנים של הודעות פוש משויכים. |
ביקורות
ביקורות על מוצרים שנשלחו על ידי לקוחות.
- שם הטבלה: ביקורות
- נקודת קצה:
/reviews - הפניית Klaviyo API: Get Reviews
| שם השדה | סוג | נתיב 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 |
REPEATED STRING | $.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 |
REPEATED STRING | $.relationships.events.data[*].id |
מזהי אירועים משויכים. |
פלחים
קבוצות דינמיות של פרופילים שמבוססות על קריטריונים ספציפיים.
- שם הטבלה: Segments
- נקודת קצה:
/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 |
REPEATED STRING | $.relationships.tags.data[*].id |
מזהים של תגים משויכים. |
flow_triggers_ids |
REPEATED STRING | $.relationships.flow-triggers.data[*].id |
מזהים של תהליכים שהופעלו על ידי הפלח הזה. |
condition_groups |
רשומה חוזרת | $.attributes.definition.condition_groups[*] |
קבוצות של תנאים לוגיים שמגדירים את הפלח. |
ConditionGroup
| שם השדה | סוג | נתיב JSON | תיאור |
|---|---|---|---|
conditions |
תנאי חוזר | conditions[*] |
רשימה של תנאים נפרדים בתוך הקבוצה. |
תנאי
| שם השדה | סוג | נתיב JSON | תיאור |
|---|---|---|---|
type |
מחרוזת | type |
סוג התנאי (למשל, profile-property). |
value |
JSON | N/A |
ערך או הגדרה של תנאי. |
תגים
תגים שמשמשים לארגון קמפיינים, תהליכים ורשימות.
- שם הטבלה: Tags
- נקודת קצה:
/tags - הפניית API של Klaviyo: Get Tags
| שם השדה | סוג | נתיב JSON | תיאור |
|---|---|---|---|
type |
מחרוזת | $.type |
סוג המשאב (תמיד tag). |
id |
מחרוזת | $.id |
מזהה תג ייחודי. |
name |
מחרוזת | $.attributes.name |
שם התג. |
tag_group_id |
מחרוזת | $.relationships.tag-group.data.id |
המזהה של קבוצת התגים שהתג הזה שייך אליה. |
תבניות
תבניות אימייל והודעות.
- שם הטבלה: Templates
- נקודת קצה:
/templates - הפניית Klaviyo API: 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 - הפניית Klaviyo API: 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.
- שם הטבלה: DataSources
- נקודת קצה:
/data-sources - הפניית API של Klaviyo: קבלת מקורות נתונים
| שם השדה | סוג | נתיב JSON | תיאור |
|---|---|---|---|
type |
מחרוזת | $.type |
סוג המשאב (תמיד data-source). |
id |
מחרוזת | $.id |
מזהה ייחודי. |
title |
מחרוזת | $.attributes.title |
השם של מקור הנתונים. |
visibility |
מחרוזת | $.attributes.visibility |
רמת החשיפה. |
description |
מחרוזת | $.attributes.description |
טקסט התיאור. |
קמפיינים
קמפיינים שיווקיים שנשלחים לרשימות או לפלחים.
- שם הטבלה: Campaigns
- נקודת קצה:
/campaigns - הפניית API של Klaviyo: Get Campaigns
| שם השדה | סוג | נתיב JSON | תיאור |
|---|---|---|---|
type |
מחרוזת | $.type |
סוג המשאב (תמיד campaign). |
id |
מחרוזת | $.id |
מזהה ייחודי. |
name |
מחרוזת | $.attributes.name |
שם הקמפיין. |
status |
מחרוזת | $.attributes.status |
סטטוס הקמפיין (למשל, נשלח, תזמון). |
archived |
בוליאני | $.attributes.archived |
האם הקמפיין הועבר לארכיון. |
included |
REPEATED STRING | $.attributes.audiences.included |
מזהים של רשימות או פלחים שנכללים. |
excluded |
REPEATED STRING | $.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 |
REPEATED STRING | $.relationships.tags.data[*].id |
מזהים של תגים משויכים. |
campaign_message_ids |
REPEATED STRING | $.relationships.campaign-messages.data[*].id |
מזהי ההודעות שכלולות בקמפיין הזה. |
CampaignMessages
הודעות ספציפיות (אימייל או SMS) בקמפיין.
- שם הטבלה: CampaignMessages
- נקודת קצה:
/campaign-messages - הפניית Klaviyo API: Get Campaign Message
| שם השדה | סוג | נתיב JSON | תיאור |
|---|---|---|---|
type |
מחרוזת | $.type |
סוג המשאב (תמיד campaign-message). |
id |
מחרוזת | $.id |
מזהה ייחודי. |
definition |
JSON | $.attributes.definition |
התוכן וההגדרות של ההודעה. |
send_times |
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 - הפניית API של Klaviyo: Get Catalog Categories
| שם השדה | סוג | נתיב JSON | תיאור |
|---|---|---|---|
type |
מחרוזת | $.type |
סוג המשאב. |
id |
מחרוזת | $.id |
מזהה ייחודי. |
name |
מחרוזת | $.attributes.name |
שם הקטגוריה. |
external_id |
מחרוזת | $.attributes.external_id |
מזהה מערכת חיצונית. |
updated |
TIMESTAMP | $.attributes.updated |
חותמת הזמן של העדכון האחרון. |
פריטים
מוצרים או פריטים ספציפיים בקטלוג.
- שם הטבלה: Items
- נקודת קצה:
/catalog-items - הפניית Klaviyo API: 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 |
REPEATED STRING | $.attributes.images[*] |
רשימה של כתובות URL נוספות של תמונות. |
custom_metadata |
JSON | $.attributes.custom_metadata |
ערכי מפתח של מטא-נתונים בהתאמה אישית. |
published |
בוליאני | $.attributes.published |
סטטוס אתר החדשות. |
created |
TIMESTAMP | $.attributes.created |
חותמת הזמן של היצירה. |
updated |
TIMESTAMP | $.attributes.updated |
חותמת הזמן של העדכון האחרון. |
variants_ids |
REPEATED STRING | $.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 |
REPEATED STRING | $.attributes.images[*] |
רשימת תמונות. |
published |
בוליאני | $.attributes.published |
סטטוס אתר החדשות. |
created |
TIMESTAMP | $.attributes.created |
חותמת הזמן של היצירה. |
updated |
TIMESTAMP | $.attributes.updated |
חותמת הזמן של העדכון האחרון. |