Referensi model data Klaviyo
Halaman ini mencantumkan data yang ditransfer ke BigQuery saat Anda menjalankan transfer data Klaviyo. Data diatur ke dalam tabel yang mencantumkan setiap nama kolom, jenis data tujuan terkait, dan jalur JSON dari data sumber.
Akun
Informasi dan metadata akun Klaviyo.
- Nama tabel: Accounts
- Endpoint:
/accounts - Referensi API Klaviyo: Get Accounts
| Nama Kolom | Jenis | Jalur JSON | Deskripsi |
|---|---|---|---|
type |
STRING | $.type |
Jenis resource (selalu account). |
id |
STRING | $.id |
ID unik untuk akun. |
test_account |
STRING | $.attributes.test_account |
Menunjukkan apakah akun ini adalah akun pengujian. |
default_sender_name |
STRING | $.attributes.contact_information.default_sender_name |
Nama default yang digunakan sebagai pengirim email. |
default_sender_email |
STRING | $.attributes.contact_information.default_sender_email |
Alamat email default yang digunakan sebagai pengirim. |
website_url |
STRING | $.attributes.contact_information.website_url |
URL situs organisasi. |
organization_name |
STRING | $.attributes.contact_information.organization_name |
Nama organisasi. |
address1 |
STRING | $.attributes.contact_information.street_address.address1 |
Baris alamat 1. |
address2 |
STRING | $.attributes.contact_information.street_address.address2 |
Baris alamat 2. |
city |
STRING | $.attributes.contact_information.street_address.city |
Kota organisasi. |
region |
STRING | $.attributes.contact_information.street_address.region |
Negara bagian, provinsi, atau wilayah. |
country |
STRING | $.attributes.contact_information.street_address.country |
Negara. |
zip |
STRING | $.attributes.contact_information.street_address.zip |
Kode pos. |
industry |
STRING | $.attributes.industry |
Vertikal industri akun. |
timezone |
STRING | $.attributes.timezone |
Setelan zona waktu untuk akun. |
preferred_currency |
STRING | $.attributes.preferred_currency |
Mata uang utama yang digunakan oleh akun. |
public_api_key |
STRING | $.attributes.public_api_key |
Kunci API publik (ID Situs) untuk integrasi sisi klien. |
locale |
STRING | $.attributes.locale |
Setelan lokal (misalnya, en-US). |
Kupon
Kupon untuk diskon dan promosi.
- Nama tabel: Kupon
- Endpoint:
/coupons - Referensi API Klaviyo: Get Coupons
| Nama Kolom | Jenis | Jalur JSON | Deskripsi |
|---|---|---|---|
type |
STRING | $.type |
Jenis resource (selalu coupon). |
id |
STRING | $.id |
ID internal unik untuk kupon. |
external_id |
STRING | $.attributes.external_id |
ID eksternal (sering kali sama dengan nama/ID). |
description |
STRING | $.attributes.description |
Deskripsi penawaran kupon. |
low_balance_threshold |
STRING | $.attributes.monitor_configuration.low_balance_threshold |
Nilai minimum untuk memicu pemberitahuan saldo rendah. |
CouponCode
Kode unik perorangan yang dibuat untuk kupon tertentu.
- Nama tabel: CouponCode
- Endpoint:
/coupon-codes - Referensi API Klaviyo: Dapatkan Kode Kupon
| Nama Kolom | Jenis | Jalur JSON | Deskripsi |
|---|---|---|---|
type |
STRING | $.type |
Jenis resource (selalu coupon-code). |
id |
STRING | $.id |
ID unik untuk instance kode spesifik ini. |
unique_code |
STRING | $.attributes.unique_code |
String kode alfanumerik yang sebenarnya. |
expires_at |
TIMESTAMP | $.attributes.expires_at |
Stempel waktu saat masa berlaku kode ini berakhir. |
status |
STRING | $.attributes.status |
Status kode (misalnya, ASSIGNED, UNASSIGNED). |
coupon_id |
STRING | $.relationships.coupon.data.id |
ID definisi Kupon induk. |
Acara
Peristiwa aktivitas yang dilacak untuk profil (misalnya, Melakukan Pemesanan, Melihat Produk).
- Nama tabel: Events
- Endpoint:
/events - Referensi API Klaviyo: Get Events
| Nama Kolom | Jenis | Jalur JSON | Deskripsi |
|---|---|---|---|
type |
STRING | $.type |
Jenis resource (selalu event). |
id |
STRING | $.id |
ID unik untuk peristiwa. |
timestamp |
FLOAT | $.attributes.timestamp |
Stempel waktu Unix saat peristiwa terjadi. |
event_properties |
JSON | $.attributes.event_properties |
Properti JSON kustom khusus untuk jenis peristiwa (misalnya, item dalam pesanan). |
datetime |
TIMESTAMP | $.attributes.datetime |
Stempel waktu ISO 8601 peristiwa. |
uuid |
STRING | $.attributes.uuid |
ID Unik Universal untuk acara. |
profile_id |
STRING | $.relationships.profile.data.id |
ID profil (pelanggan) yang terkait dengan peristiwa. |
metric_id |
STRING | $.relationships.metric.data.id |
ID definisi metrik (jenis peristiwa). |
attribution_ids |
REPEATED STRING | $.relationships.attributions.data[*].id |
ID kampanye/alur yang diatribusikan ke peristiwa ini. |
Flow
Alur pemasaran otomatis yang dipicu oleh peristiwa atau kondisi tertentu.
- Nama tabel: Flows
- Endpoint:
/flows - Referensi API Klaviyo: Get Flows
| Nama Kolom | Jenis | Jalur JSON | Deskripsi |
|---|---|---|---|
type |
STRING | $.type |
Jenis resource (selalu flow). |
id |
STRING | $.id |
ID unik untuk alur. |
name |
STRING | $.attributes.name |
Nama alur. |
status |
STRING | $.attributes.status |
Status operasional (misalnya, aktif, draf). |
archived |
BOOLEAN | $.attributes.archived |
Apakah alur diarsipkan. |
created |
TIMESTAMP | $.attributes.created |
Stempel waktu pembuatan. |
updated |
TIMESTAMP | $.attributes.updated |
Stempel waktu modifikasi terakhir. |
trigger_type |
STRING | $.attributes.trigger_type |
Mekanisme yang memicu alur (misalnya, "Ditambahkan ke Daftar", "Metrik"). |
flow_actions_ids |
REPEATED STRING | $.relationships.flow-actions.data[*].id |
ID tindakan (langkah) dalam alur ini. |
tag_ids |
REPEATED STRING | $.relationships.tags.data[*].id |
ID tag yang ditetapkan ke alur ini. |
Formulir
Formulir pendaftaran untuk mengumpulkan informasi pelanggan.
- Nama tabel: Formulir
- Endpoint:
/forms - Referensi API Klaviyo: Get Forms
| Nama Kolom | Jenis | Jalur JSON | Deskripsi |
|---|---|---|---|
type |
STRING | $.type |
Jenis resource (selalu form). |
id |
STRING | $.id |
ID unik untuk formulir. |
name |
STRING | $.attributes.name |
Nama formulir. |
status |
STRING | $.attributes.status |
Status formulir (misalnya, aktif, draf). |
ab_test |
BOOLEAN | $.attributes.ab_test |
Apakah formulir menjalankan pengujian A/B. |
created_at |
TIMESTAMP | $.attributes.created_at |
Stempel waktu pembuatan. |
updated_at |
TIMESTAMP | $.attributes.updated_at |
Stempel waktu modifikasi terakhir. |
Gambar
Gambar yang diupload ke Klaviyo untuk digunakan dalam kampanye dan template.
- Nama tabel: Images
- Endpoint:
/images - Referensi API Klaviyo: Get Images
| Nama Kolom | Jenis | Jalur JSON | Deskripsi |
|---|---|---|---|
type |
STRING | $.type |
Jenis resource (selalu image). |
id |
STRING | $.id |
ID unik. |
name |
STRING | $.attributes.name |
Nama file atau nama gambar. |
image_url |
STRING | $.attributes.image_url |
URL publik untuk mengakses gambar. |
format |
STRING | $.attributes.format |
Format file gambar (misalnya, jpeg, png). |
size |
FLOAT | $.attributes.size |
Ukuran file dalam byte. |
hidden |
BOOLEAN | $.attributes.hidden |
Apakah gambar disembunyikan di UI. |
updated_at |
TIMESTAMP | $.attributes.updated_at |
Stempel waktu modifikasi terakhir. |
Daftar
Daftar kontak/profil statis.
- Nama tabel: Lists
- Endpoint:
/lists - Referensi API Klaviyo: Get Lists
| Nama Kolom | Jenis | Jalur JSON | Deskripsi |
|---|---|---|---|
type |
STRING | $.type |
Jenis resource (selalu list). |
id |
STRING | $.id |
ID unik untuk daftar. |
name |
STRING | $.attributes.name |
Nama daftar kontak. |
created |
TIMESTAMP | $.attributes.created |
Stempel waktu pembuatan. |
updated |
TIMESTAMP | $.attributes.updated |
Stempel waktu modifikasi terakhir. |
opt_in_process |
STRING | $.attributes.opt_in_process |
Setelan keikutsertaan (misalnya, 'singleoptin' atau 'doubleoptin'). |
tag_ids |
REPEATED STRING | $.relationships.tags.data[*].id |
ID tag yang ditetapkan ke daftar ini. |
flow_triggers_ids |
REPEATED STRING | $.relationships.flow-triggers.data[*].id |
ID alur yang dipicu dengan menambahkan profil ke daftar ini. |
Metrik
Jenis peristiwa yang dapat dilacak (misalnya, "Email Diterima").
- Nama tabel: Metrics
- Endpoint:
/metrics - Referensi API Klaviyo: Get Metrics
| Nama Kolom | Jenis | Jalur JSON | Deskripsi |
|---|---|---|---|
type |
STRING | $.type |
Jenis resource (selalu metric). |
id |
STRING | $.id |
ID unik (misalnya, kode 6 karakter untuk generik, UUID panjang untuk kustom). |
name |
STRING | $.attributes.name |
Nama yang dapat dibaca manusia (misalnya, "Pesanan yang Dilakukan"). |
created |
TIMESTAMP | $.attributes.created |
Stempel waktu pembuatan. |
updated |
TIMESTAMP | $.attributes.updated |
Stempel waktu modifikasi terakhir. |
integration |
JSON | $.attributes.integration |
Info tentang integrasi yang menyediakan metrik ini (misalnya, nama, kategori, gambar). |
flow_triggers_ids |
REPEATED STRING | $.relationships.flow-triggers.data[*].id |
ID alur yang dipicu oleh metrik ini. |
Profil
Profil pelanggan yang komprehensif yang berisi atribut dan histori aktivitas.
- Nama tabel: Profiles
- Endpoint:
/profiles - Referensi API Klaviyo: Get Profiles
| Nama Kolom | Jenis | Jalur JSON | Deskripsi |
|---|---|---|---|
type |
STRING | $.type |
Jenis resource (selalu profile). |
id |
STRING | $.id |
ID Klaviyo unik untuk profil. |
email |
STRING | $.attributes.email |
Alamat email utama. |
phone_number |
STRING | $.attributes.phone_number |
Nomor telepon dalam format E.164. |
external_id |
STRING | $.attributes.external_id |
ID dari sistem eksternal. |
first_name |
STRING | $.attributes.first_name |
First name. |
last_name |
STRING | $.attributes.last_name |
Last name. |
organization |
STRING | $.attributes.organization |
Nama perusahaan atau organisasi. |
locale |
STRING | $.attributes.locale |
Setelan Lokalitas/Bahasa. |
title |
STRING | $.attributes.title |
Jabatan. |
image |
STRING | $.attributes.image |
URL gambar profil. |
created |
TIMESTAMP | $.attributes.created |
Stempel waktu pembuatan profil. |
updated |
TIMESTAMP | $.attributes.updated |
Stempel waktu pembaruan terakhir. |
last_event_date |
TIMESTAMP | $.attributes.last_event_date |
Stempel waktu peristiwa terbaru. |
address1 |
STRING | $.attributes.location.address1 |
Baris alamat 1. |
address2 |
STRING | $.attributes.location.address2 |
Baris alamat 2. |
city |
STRING | $.attributes.location.city |
Kota. |
country |
STRING | $.attributes.location.country |
Negara. |
latitude |
STRING | $.attributes.location.latitude |
Koordinat lintang. |
longitude |
STRING | $.attributes.location.longitude |
Koordinat bujur. |
region |
STRING | $.attributes.location.region |
Negara bagian/provinsi atau wilayah. |
zip |
STRING | $.attributes.location.zip |
Kode pos. |
timezone |
STRING | $.attributes.location.timezone |
Zona waktu. |
ip |
STRING | $.attributes.location.ip |
alamat IP eksternal. |
properties |
JSON | $.attributes.properties |
Pasangan nilai kunci properti kustom. |
email_marketing_can_receive_email_marketing |
BOOLEAN | $.attributes.subscriptions.email.marketing.can_receive_email_marketing |
Apakah profil dapat menerima marketing melalui email. |
email_marketing_consent |
STRING | $.attributes.subscriptions.email.marketing.consent |
Status izin (misalnya, SUBSCRIBED, UNSUBSCRIBED). |
email_marketing_consent_timestamp |
TIMESTAMP | $.attributes.subscriptions.email.marketing.consent_timestamp |
Waktu izin diberikan. |
email_marketing_last_updated |
TIMESTAMP | $.attributes.subscriptions.email.marketing.last_updated |
Kapan izin email terakhir diperbarui. |
email_marketing_method |
STRING | $.attributes.subscriptions.email.marketing.method |
Metode izin (misalnya, FORMULIR). |
email_marketing_method_detail |
STRING | $.attributes.subscriptions.email.marketing.method_detail |
Sumber spesifik metode. |
email_marketing_custom_method_detail |
STRING | $.attributes.subscriptions.email.marketing.custom_method_detail |
Detail kustom untuk metode izin. |
email_marketing_double_optin |
BOOLEAN | $.attributes.subscriptions.email.marketing.double_optin |
Apakah keikutsertaan dengan verifikasi tambahan telah diselesaikan. |
sms_marketing_can_receive_sms_marketing |
BOOLEAN | $.attributes.subscriptions.sms.marketing.can_receive_sms_marketing |
Apakah profil dapat menerima pemasaran SMS. |
sms_marketing_consent |
STRING | $.attributes.subscriptions.sms.marketing.consent |
Status izin SMS. |
sms_marketing_consent_timestamp |
TIMESTAMP | $.attributes.subscriptions.sms.marketing.consent_timestamp |
Waktu izin SMS diberikan. |
sms_marketing_last_updated |
TIMESTAMP | $.attributes.subscriptions.sms.marketing.last_updated |
Kapan izin SMS terakhir diperbarui. |
sms_marketing_method |
STRING | $.attributes.subscriptions.sms.marketing.method |
Metode izin SMS. |
sms_marketing_method_detail |
STRING | $.attributes.subscriptions.sms.marketing.method_detail |
Detail metode izin SMS. |
sms_transactional_can_receive_sms_transactional |
BOOLEAN | $.attributes.subscriptions.sms.transactional.can_receive_sms_transactional |
Apakah profil dapat menerima SMS transaksional. |
sms_transactional_consent |
STRING | $.attributes.subscriptions.sms.transactional.consent |
Status izin SMS transaksional. |
sms_transactional_consent_timestamp |
TIMESTAMP | $.attributes.subscriptions.sms.transactional.consent_timestamp |
Waktu saat izin transaksional diberikan. |
sms_transactional_last_updated |
TIMESTAMP | $.attributes.subscriptions.sms.transactional.last_updated |
Waktu saat status transaksi terakhir diperbarui. |
sms_transactional_method |
STRING | $.attributes.subscriptions.sms.transactional.method |
Metode SMS transaksional. |
sms_transactional_method_detail |
STRING | $.attributes.subscriptions.sms.transactional.method_detail |
Detail metode SMS transaksional. |
mobile_push_can_receive_push_marketing |
BOOLEAN | $.attributes.subscriptions.mobile_push.marketing.can_receive_push_marketing |
Apakah profil dapat menerima push marketing. |
mobile_push_consent |
STRING | $.attributes.subscriptions.mobile_push.marketing.consent |
Kirim status izin. |
mobile_push_consent_timestamp |
TIMESTAMP | $.attributes.subscriptions.mobile_push.marketing.consent_timestamp |
Saat izin push diberikan. |
predictive_analytics_historic_number_of_orders |
FLOAT | $.attributes.predictive_analytics.historic_number_of_orders |
Total pesanan historis. |
predictive_analytics_predicted_number_of_orders |
FLOAT | $.attributes.predictive_analytics.predicted_number_of_orders |
Pesanan mendatang yang diprediksi. |
predictive_analytics_average_days_between_orders |
FLOAT | $.attributes.predictive_analytics.average_days_between_orders |
Rata-rata hari di antara pesanan. |
predictive_analytics_average_order_value |
FLOAT | $.attributes.predictive_analytics.average_order_value |
Nilai pesanan rata-rata historis. |
predictive_analytics_historic_clv |
FLOAT | $.attributes.predictive_analytics.historic_clv |
Nilai Umur Pelanggan Historis. |
predictive_analytics_predicted_clv |
FLOAT | $.attributes.predictive_analytics.predicted_clv |
Prediksi Nilai Umur Pelanggan. |
predictive_analytics_total_clv |
FLOAT | $.attributes.predictive_analytics.total_clv |
CLV Historis + Prediksi. |
predictive_analytics_churn_probability |
FLOAT | $.attributes.predictive_analytics.churn_probability |
Probabilitas churn (0-1). |
predictive_analytics_expected_date_of_next_order |
TIMESTAMP | $.attributes.predictive_analytics.expected_date_of_next_order |
Perkiraan tanggal pesanan berikutnya. |
email_marketing_suppression_reason |
JSON BERULANG | $.attributes.subscriptions.email.marketing.suppression[*] |
Alasan penekanan email (misalnya, email tidak terkirim). |
email_marketing_list_suppressions_reason |
JSON BERULANG | $.attributes.subscriptions.email.marketing.list_suppressions[*] |
Alasan penekanan khusus daftar. |
push_tokens_ids |
REPEATED STRING | $.relationships.push-tokens.data[*].id |
ID token push terkait. |
Ulasan
Ulasan produk yang dikirim oleh pelanggan.
- Nama tabel: Reviews
- Endpoint:
/reviews - Referensi API Klaviyo: Get Reviews
| Nama Kolom | Jenis | Jalur JSON | Deskripsi |
|---|---|---|---|
type |
STRING | $.type |
Jenis resource (selalu review). |
id |
STRING | $.id |
ID unik untuk ulasan. |
email |
STRING | $.attributes.email |
Email peninjau. |
value |
STRING | $.attributes.status.value |
Nilai status (misalnya, dipublikasikan, ditolak). |
reason |
STRING | $.attributes.status.rejection_reason.reason |
Alasan penolakan jika ada. |
status_explanation |
STRING | $.attributes.status.rejection_reason.status_explanation |
Penjelasan mendetail tentang status. |
verified |
BOOLEAN | $.attributes.verified |
Apakah pembelian telah diverifikasi. |
review_type |
STRING | $.attributes.review_type |
Jenis ulasan (misalnya, ulasan produk). |
created |
TIMESTAMP | $.attributes.created |
Stempel waktu pembuatan. |
updated |
TIMESTAMP | $.attributes.updated |
Stempel waktu modifikasi terakhir. |
images |
REPEATED STRING | $.attributes.images[*] |
URL gambar yang dilampirkan ke ulasan. |
product_url |
STRING | $.attributes.product.url |
URL produk yang diulas. |
product_name |
STRING | $.attributes.product.name |
Nama produk. |
product_image_url |
STRING | $.attributes.product.image_url |
URL gambar produk. |
product_external_id |
STRING | $.attributes.product.external_id |
ID eksternal produk. |
rating |
INTEGER | $.attributes.rating |
Skor rating. |
author |
STRING | $.attributes.author |
Nama pengulas. |
content |
STRING | $.attributes.content |
Konten teks ulasan. |
title |
STRING | $.attributes.title |
Judul ulasan. |
smart_quote |
STRING | $.attributes.smart_quote |
Kutipan yang ditandai dari ulasan. |
public_reply_content |
STRING | $.attributes.public_reply.content |
Konten balasan publik penjual. |
public_reply_author |
STRING | $.attributes.public_reply.author |
Penulis balasan. |
public_reply_updated |
STRING | $.attributes.public_reply.updated |
Stempel waktu pembaruan balasan. |
event_ids |
REPEATED STRING | $.relationships.events.data[*].id |
ID peristiwa terkait. |
Segmen
Grup profil dinamis berdasarkan kriteria tertentu.
- Nama tabel: Segments
- Endpoint:
/segments - Referensi API Klaviyo: Get Segments
| Nama Kolom | Jenis | Jalur JSON | Deskripsi |
|---|---|---|---|
type |
STRING | $.type |
Jenis resource (selalu segment). |
id |
STRING | $.id |
ID unik untuk segmen. |
name |
STRING | $.attributes.name |
Nama segmen. |
created |
TIMESTAMP | $.attributes.created |
Stempel waktu pembuatan. |
updated |
TIMESTAMP | $.attributes.updated |
Stempel waktu modifikasi terakhir. |
is_active |
BOOLEAN | $.attributes.is_active |
Apakah segmen aktif. |
is_processing |
BOOLEAN | $.attributes.is_processing |
Apakah segmen sedang diproses. |
is_starred |
BOOLEAN | $.attributes.is_starred |
Apakah segmen diberi bintang/difavoritkan. |
tag_ids |
REPEATED STRING | $.relationships.tags.data[*].id |
ID tag terkait. |
flow_triggers_ids |
REPEATED STRING | $.relationships.flow-triggers.data[*].id |
ID alur yang dipicu oleh segmen ini. |
condition_groups |
REPEATED ConditionGroup | $.attributes.definition.condition_groups[*] |
Grup kondisi logika yang menentukan segmen. |
ConditionGroup
| Nama Kolom | Jenis | Jalur JSON | Deskripsi |
|---|---|---|---|
conditions |
Kondisi REPEATED | conditions[*] |
Daftar kondisi individual dalam grup. |
Kondisi
| Nama Kolom | Jenis | Jalur JSON | Deskripsi |
|---|---|---|---|
type |
STRING | type |
Jenis kondisi (misalnya, profile-property). |
value |
JSON | N/A |
Nilai/konfigurasi kondisi. |
Tag
Tag yang digunakan untuk mengatur kampanye, alur, dan daftar.
- Nama tabel: Tags
- Endpoint:
/tags - Referensi API Klaviyo: Get Tags
| Nama Kolom | Jenis | Jalur JSON | Deskripsi |
|---|---|---|---|
type |
STRING | $.type |
Jenis resource (selalu tag). |
id |
STRING | $.id |
ID tag unik. |
name |
STRING | $.attributes.name |
Nama tag. |
tag_group_id |
STRING | $.relationships.tag-group.data.id |
ID grup tag yang memiliki tag ini. |
Template
Template email dan pesan.
- Nama tabel: Templates
- Endpoint:
/templates - Referensi API Klaviyo: Get Templates
| Nama Kolom | Jenis | Jalur JSON | Deskripsi |
|---|---|---|---|
type |
STRING | $.type |
Jenis resource (selalu template). |
id |
STRING | $.id |
ID unik. |
name |
STRING | $.attributes.name |
Nama template. |
editor_type |
STRING | $.attributes.editor_type |
Editor yang digunakan (misalnya, tarik lalu lepas). |
html |
STRING | $.attributes.html |
Konten HTML |
text |
STRING | $.attributes.text |
Versi teks template. |
| amp | STRING | $.attributes.amp |
Versi AMP template. |
created |
TIMESTAMP | $.attributes.created |
Stempel waktu pembuatan. |
updated |
TIMESTAMP | $.attributes.updated |
Stempel waktu pembaruan terakhir. |
WebFeeds
Feed web yang digunakan untuk mengisi konten dalam pesan.
- Nama tabel: WebFeeds
- Endpoint:
/web-feeds - Referensi API Klaviyo: Get Web Feeds
| Nama Kolom | Jenis | Jalur JSON | Deskripsi |
|---|---|---|---|
type |
STRING | $.type |
Jenis resource (selalu web-feed). |
id |
STRING | $.id |
ID unik. |
name |
STRING | $.attributes.name |
Nama feed. |
url |
STRING | $.attributes.url |
URL Sumber Feed. |
request_method |
STRING | $.attributes.request_method |
Metode HTTP (GET/POST). |
content_type |
STRING | $.attributes.content_type |
Jenis konten (misalnya, JSON). |
status |
STRING | $.attributes.status |
Status feed. |
created |
TIMESTAMP | $.attributes.created |
Stempel waktu pembuatan. |
updated |
TIMESTAMP | $.attributes.updated |
Stempel waktu pembaruan terakhir. |
DataSources
Sumber data yang diintegrasikan ke Klaviyo.
- Nama tabel: DataSources
- Endpoint:
/data-sources - Referensi API Klaviyo: Get Data Sources
| Nama Kolom | Jenis | Jalur JSON | Deskripsi |
|---|---|---|---|
type |
STRING | $.type |
Jenis resource (selalu data-source). |
id |
STRING | $.id |
ID unik. |
title |
STRING | $.attributes.title |
Judul sumber data. |
visibility |
STRING | $.attributes.visibility |
Tingkat visibilitas. |
description |
STRING | $.attributes.description |
Teks deskripsi. |
Kampanye
Kampanye pemasaran yang dikirim ke daftar atau segmen.
- Nama tabel: Campaigns
- Endpoint:
/campaigns - Referensi API Klaviyo: Get Campaigns
| Nama Kolom | Jenis | Jalur JSON | Deskripsi |
|---|---|---|---|
type |
STRING | $.type |
Jenis resource (selalu campaign). |
id |
STRING | $.id |
ID unik. |
name |
STRING | $.attributes.name |
Nama kampanye. |
status |
STRING | $.attributes.status |
Status kampanye (misalnya, Terkirim, Penjadwalan). |
archived |
BOOLEAN | $.attributes.archived |
Apakah kampanye diarsipkan. |
included |
REPEATED STRING | $.attributes.audiences.included |
ID daftar/segmen yang disertakan. |
excluded |
REPEATED STRING | $.attributes.audiences.excluded |
ID daftar/segmen yang dikecualikan. |
send_options |
JSON | $.attributes.send_options |
Konfigurasi untuk pengiriman (misalnya, pengiriman cerdas). |
tracking_options |
JSON | $.attributes.tracking_options |
Konfigurasi untuk pelacakan (misalnya, parameter utm). |
send_strategy |
JSON | $.attributes.send_strategy |
Strategi untuk waktu pengiriman. |
created_at |
TIMESTAMP | $.attributes.created_at |
Stempel waktu pembuatan. |
scheduled_at |
TIMESTAMP | $.attributes.scheduled_at |
Waktu pengiriman kampanye yang dijadwalkan. |
updated_at |
TIMESTAMP | $.attributes.updated_at |
Stempel waktu pembaruan terakhir. |
send_time |
TIMESTAMP | $.attributes.send_time |
Waktu pengiriman yang sebenarnya. |
tag_ids |
REPEATED STRING | $.relationships.tags.data[*].id |
ID tag terkait. |
campaign_message_ids |
REPEATED STRING | $.relationships.campaign-messages.data[*].id |
ID pesan yang ada dalam kampanye ini. |
CampaignMessages
Pesan individual (email/SMS) dalam kampanye.
- Nama tabel: CampaignMessages
- Endpoint:
/campaign-messages - Referensi API Klaviyo: Get Campaign Message
| Nama Kolom | Jenis | Jalur JSON | Deskripsi |
|---|---|---|---|
type |
STRING | $.type |
Jenis resource (selalu campaign-message). |
id |
STRING | $.id |
ID unik. |
definition |
JSON | $.attributes.definition |
Konten dan konfigurasi pesan. |
send_times |
JSON BERULANG | $.attributes.send_times[*] |
Waktu pengiriman terjadwal. |
created_at |
TIMESTAMP | $.attributes.created_at |
Stempel waktu pembuatan. |
updated_at |
TIMESTAMP | $.attributes.updated_at |
Stempel waktu pembaruan terakhir. |
campaign_id |
STRING | $.relationships.campaign.data.id |
ID kampanye induk. |
template_id |
STRING | $.relationships.template.data.id |
ID template yang digunakan. |
image_id |
STRING | $.relationships.image.data.id |
ID gambar terlampir. |
Kategori
Kategori produk dari katalog Anda.
- Nama tabel: Categories
- Endpoint:
/catalog-categories - Referensi API Klaviyo: Get Catalog Categories
| Nama Kolom | Jenis | Jalur JSON | Deskripsi |
|---|---|---|---|
type |
STRING | $.type |
Jenis resource. |
id |
STRING | $.id |
ID unik. |
name |
STRING | $.attributes.name |
Nama kategori. |
external_id |
STRING | $.attributes.external_id |
ID sistem eksternal. |
updated |
TIMESTAMP | $.attributes.updated |
Stempel waktu pembaruan terakhir. |
Item
Produk atau item individual di katalog Anda.
- Nama tabel: Items
- Endpoint:
/catalog-items - Referensi API Klaviyo: Get Catalog Items
| Nama Kolom | Jenis | Jalur JSON | Deskripsi |
|---|---|---|---|
type |
STRING | $.type |
Jenis resource. |
id |
STRING | $.id |
ID unik. |
external_id |
STRING | $.attributes.external_id |
ID sistem eksternal. |
title |
STRING | $.attributes.title |
Judul/nama item. |
description |
STRING | $.attributes.description |
Deskripsi tersedia. |
price |
FLOAT | $.attributes.price |
Harga item. |
url |
STRING | $.attributes.url |
URL ke item. |
image_full_url |
STRING | $.attributes.image_full_url |
URL gambar ukuran penuh. |
image_thumbnail_url |
STRING | $.attributes.image_thumbnail_url |
URL gambar thumbnail. |
images |
REPEATED STRING | $.attributes.images[*] |
Daftar URL gambar tambahan. |
custom_metadata |
JSON | $.attributes.custom_metadata |
Nilai kunci metadata kustom. |
published |
BOOLEAN | $.attributes.published |
Status publikasi. |
created |
TIMESTAMP | $.attributes.created |
Stempel waktu pembuatan. |
updated |
TIMESTAMP | $.attributes.updated |
Stempel waktu pembaruan terakhir. |
variants_ids |
REPEATED STRING | $.relationships.variants.data[*].id |
ID varian untuk item ini. |
Varian
Varian tertentu dari item katalog (misalnya, ukuran, warna).
- Nama tabel: Variants
- Endpoint:
/catalog-variants - Referensi API Klaviyo: Get Catalog Variants
| Nama Kolom | Jenis | Jalur JSON | Deskripsi |
|---|---|---|---|
type |
STRING | $.type |
Jenis resource. |
id |
STRING | $.id |
ID unik. |
external_id |
STRING | $.attributes.external_id |
ID sistem eksternal. |
title |
STRING | $.attributes.title |
Judul varian. |
description |
STRING | $.attributes.description |
Deskripsi tersedia. |
sku |
STRING | $.attributes.sku |
Unit Penyimpanan Persediaan. |
inventory_policy |
FLOAT | $.attributes.inventory_policy |
Kebijakan untuk pengelolaan inventaris. |
inventory_quantity |
FLOAT | $.attributes.inventory_quantity |
Jumlah stok saat ini. |
price |
FLOAT | $.attributes.price |
Harga. |
url |
STRING | $.attributes.url |
URL ke varian. |
image_full_url |
STRING | $.attributes.image_full_url |
URL gambar lengkap tersedia (Boolean). |
image_thumbnail_url |
STRING | $.attributes.image_thumbnail_url |
URL gambar thumbnail. |
images |
REPEATED STRING | $.attributes.images[*] |
Daftar gambar. |
published |
BOOLEAN | $.attributes.published |
Status publikasi. |
created |
TIMESTAMP | $.attributes.created |
Stempel waktu pembuatan. |
updated |
TIMESTAMP | $.attributes.updated |
Stempel waktu pembaruan terakhir. |
FlowActions
Tindakan alur yang terkait dengan alur.
- Nama tabel: FlowActions
- Endpoint:
/flows/{id}/flow-actions - Referensi API Klaviyo: Get Flow Actions
| Nama Kolom | Jenis | Jalur JSON | Deskripsi |
|---|---|---|---|
type |
STRING | $.type |
Jenis resource. Selalu flow-action. |
id |
STRING | $.id |
ID unik untuk tindakan alur. |
created |
TIMESTAMP | $.attributes.created |
Stempel waktu pembuatan. |
updated |
TIMESTAMP | $.attributes.updated |
Stempel waktu modifikasi terakhir. |
message_id |
STRING | $.attributes.definition.id |
ID unik untuk definisi pesan tindakan. |
message_temporary_id |
STRING | $.attributes.definition.temporary_id |
ID sementara yang ditetapkan ke definisi pesan. |
message_type |
STRING | $.attributes.definition.type |
Jenis pesan, seperti email, sms. |
condition_groups |
REPEATED ConditionGroup | $.attributes.definition.data.action_output_filter.condition_groups[*] |
Kondisi yang terkait dengan filter output tindakan alur. |
next_if_true |
STRING | $.attributes.definition.links.next_if_true |
ID tindakan alur berikutnya jika kondisi bernilai true. |
next_if_false |
STRING | $.attributes.definition.links.next_if_false |
ID tindakan alur berikutnya jika kondisi bernilai false. |
FormVersions
Versi formulir untuk formulir tertentu.
- Nama tabel: FormVersions
- Endpoint:
/forms/{id}/form-versions - Referensi API Klaviyo: Get Form Versions
| Nama Kolom | Jenis | Jalur JSON | Deskripsi |
|---|---|---|---|
type |
STRING | $.type |
Jenis resource. Selalu form-version. |
id |
STRING | $.id |
ID unik untuk versi formulir. |
form_type |
STRING | $.attributes.form_type |
Jenis formulir, seperti popup, embed, banner. |
variation_name |
STRING | $.attributes.variation_name |
Nama variasi formulir. |
ab_test |
JSON | $.attributes.ab_test |
Setelan konfigurasi dan variasi pengujian A/B. |
status |
STRING | $.attributes.status |
Status operasional versi formulir, seperti draft, live. |
created_at |
TIMESTAMP | $.attributes.created_at |
Stempel waktu pembuatan. |
updated_at |
TIMESTAMP | $.attributes.updated_at |
Stempel waktu modifikasi terakhir. |
PushTokens
Token push yang terkait dengan profil aplikasi seluler untuk notifikasi push.
- Nama tabel: PushTokens
- Endpoint:
/push-tokens - Referensi API Klaviyo: Get Push Tokens
| Nama Kolom | Jenis | Jalur JSON | Deskripsi |
|---|---|---|---|
type |
STRING | $.type |
Jenis resource. Selalu push-token. |
id |
STRING | $.id |
ID unik untuk token push. |
created |
TIMESTAMP | $.attributes.created |
Stempel waktu pembuatan. |
token |
STRING | $.attributes.token |
String token push perangkat. |
enablement_status |
STRING | $.attributes.enablement_status |
Status pengaktifan notifikasi push, seperti AUTHORIZED, UNAUTHORIZED. |
platform |
STRING | $.attributes.platform |
Platform seluler, seperti ios, android. |
vendor |
STRING | $.attributes.vendor |
Penyedia layanan vendor, seperti apns, fcm. |
background |
STRING | $.attributes.background |
Status pemuatan ulang latar belakang untuk notifikasi push. |
recorded_date |
TIMESTAMP | $.attributes.recorded_date |
Tanggal saat token push dicatat. |
metadata |
JSON | $.attributes.metadata |
Metadata token push atau perangkat kustom. |
profile_id |
STRING | $.relationships.profile.data.id |
ID profil pelanggan yang terkait dengan token push ini. |
TagGroups
Grup tag yang digunakan untuk mengatur dan mengategorikan tag.
- Nama tabel: TagGroups
- Endpoint:
/tag-groups - Referensi API Klaviyo: Get Tag Groups
| Nama Kolom | Jenis | Jalur JSON | Deskripsi |
|---|---|---|---|
type |
STRING | $.type |
Jenis resource. Selalu tag-group. |
id |
STRING | $.id |
ID unik untuk grup tag. |
name |
STRING | $.attributes.name |
Nama grup tag. |
exclusive |
BOOLEAN | $.attributes.exclusive |
Apakah tag dalam grup ini saling eksklusif. |
default |
BOOLEAN | $.attributes.default |
Apakah ini adalah grup tag default untuk akun. |
UniversalContent
Blok konten universal yang dapat digunakan kembali untuk pesan dan template.
- Nama tabel: UniversalContent
- Endpoint:
/template-universal-content - Referensi API Klaviyo: Get Universal Content
| Nama Kolom | Jenis | Jalur JSON | Deskripsi |
|---|---|---|---|
type |
STRING | $.type |
Jenis resource. Selalu template-universal-content. |
id |
STRING | $.id |
ID unik untuk blok konten universal. |
name |
STRING | $.attributes.name |
Nama blok konten universal. |
definition_content_type |
STRING | $.attributes.definition.content_type |
Jenis konten definisi, seperti block, template. |
definition_type |
STRING | $.attributes.definition.type |
Jenis komponen konten, seperti text, button, image. |
definition_data |
JSON | $.attributes.definition.data |
Data struktural dan payload definisi konten. |
created |
TIMESTAMP | $.attributes.created |
Stempel waktu pembuatan. |
updated |
TIMESTAMP | $.attributes.updated |
Stempel waktu modifikasi terakhir. |
screenshot_status |
STRING | $.attributes.screenshot_status |
Status pembuatan screenshot pratinjau, seperti completed, pending. |
screenshot_url |
STRING | $.attributes.screenshot_url |
URL publik screenshot pratinjau konten. |
MetricProperties
Properti dan atribut struktural yang ditentukan untuk metrik tertentu.
- Nama tabel: MetricProperties
- Endpoint:
/metrics/{id}/metric-properties - Referensi API Klaviyo: Get Metric Properties
| Nama Kolom | Jenis | Jalur JSON | Deskripsi |
|---|---|---|---|
type |
STRING | $.type |
Jenis resource. Selalu metric-property. |
id |
STRING | $.id |
ID unik untuk properti metrik. |
sample_values |
JSON | $.attributes.sample_values |
Contoh nilai data sampel yang diambil untuk properti metrik ini. |
label |
STRING | $.attributes.label |
Label yang dapat dibaca manusia untuk properti. |
property |
STRING | $.attributes.property |
Nama kunci properti peristiwa. |
inferred_type |
STRING | $.attributes.inferred_type |
Jenis data yang disimpulkan oleh Klaviyo untuk properti ini, seperti string, boolean, numeric. |
metric_id |
STRING | $.relationships.metric.data.id |
ID definisi metrik induk. |
TrackingSettings
Parameter pelacakan UTM tingkat akun untuk kampanye dan alur.
- Nama tabel: TrackingSettings
- Endpoint:
/tracking-settings - Referensi API Klaviyo: Get Tracking Settings
| Nama Kolom | Jenis | Jalur JSON | Deskripsi |
|---|---|---|---|
type |
STRING | $.type |
Jenis resource. Selalu tracking-setting. |
id |
STRING | $.id |
ID unik untuk setelan pelacakan. |
auto_add_parameters |
BOOLEAN | $.attributes.auto_add_parameters |
Apakah parameter UTM otomatis ditambahkan ke link pesan. |
utm_source |
UtmParameter | $.attributes.utm_source |
Konfigurasi untuk _utm_source parameter dalam alur dan kampanye. |
utm_medium |
UtmParameter | $.attributes.utm_medium |
Konfigurasi untuk _utm_medium parameter dalam alur dan kampanye. |
utm_campaign |
UtmParameter | $.attributes.utm_campaign |
Konfigurasi untuk parameter _utm_campaign dalam alur dan kampanye. |
utm_id |
UtmParameter | $.attributes.utm_id |
Konfigurasi untuk parameter _utm_id dalam alur dan kampanye. |
utm_term |
UtmParameter | $.attributes.utm_term |
Konfigurasi untuk parameter _utm_term dalam alur dan kampanye. |
custom_parameters |
REPEATED CustomParameter | $.attributes.custom_parameters |
Parameter pelacakan kustom ditambahkan ke link kampanye dan alur. |
UtmParameter
| Nama Kolom | Jenis | Jalur JSON | Deskripsi |
|---|---|---|---|
flow |
ParameterContext | flow |
Konteks setelan parameter UTM untuk alur. |
campaign |
ParameterContext | campaign |
Konteks setelan parameter UTM untuk kampanye. |
ParameterContext
| Nama Kolom | Jenis | Jalur JSON | Deskripsi |
|---|---|---|---|
type |
STRING | type |
Jenis resource. |
value |
STRING | value |
Nilai template parameter atau kunci atribut, seperti emailsubject, campaignid. |
CustomParameter
| Nama Kolom | Jenis | Jalur JSON | Deskripsi |
|---|---|---|---|
flow |
ParameterContext | flow |
Konteks parameter pelacakan kustom untuk alur. |
campaign |
ParameterContext | campaign |
Konteks parameter pelacakan kustom untuk kampanye. |
name |
STRING | name |
Nama parameter pelacakan kustom. |