Referenz zum Klaviyo-Datenmodell
Auf dieser Seite sind die Daten aufgeführt, die bei einer Klaviyo-Datenübertragung an BigQuery übertragen werden. Die Daten sind in Tabellen organisiert, in denen jeder Feldname, der zugehörige Zieldatentyp und der JSON-Pfad aus den Quelldaten aufgeführt sind.
Konten
Klaviyo-Kontoinformationen und -Metadaten.
- Tabellenname: Accounts
- Endpunkt:
/accounts - Klaviyo API-Referenz: Get Accounts
| Feldname | Typ | JSON-Pfad | Beschreibung |
|---|---|---|---|
type |
STRING | $.type |
Ressourcentyp (immer account). |
id |
STRING | $.id |
Eindeutige Kennung des Kontos. |
test_account |
STRING | $.attributes.test_account |
Gibt an, ob es sich um ein Testkonto handelt. |
default_sender_name |
STRING | $.attributes.contact_information.default_sender_name |
Standardname, der als Absender für E‑Mails verwendet wird. |
default_sender_email |
STRING | $.attributes.contact_information.default_sender_email |
Standard-E-Mail-Adresse, die als Absender verwendet wird. |
website_url |
STRING | $.attributes.contact_information.website_url |
URL der Website der Organisation. |
organization_name |
STRING | $.attributes.contact_information.organization_name |
Name der Organisation. |
address1 |
STRING | $.attributes.contact_information.street_address.address1 |
Adresszeile 1. |
address2 |
STRING | $.attributes.contact_information.street_address.address2 |
Adresszeile 2. |
city |
STRING | $.attributes.contact_information.street_address.city |
Stadt der Organisation. |
region |
STRING | $.attributes.contact_information.street_address.region |
Bundesland, Provinz oder Region. |
country |
STRING | $.attributes.contact_information.street_address.country |
Land. |
zip |
STRING | $.attributes.contact_information.street_address.zip |
Postleitzahl. |
industry |
STRING | $.attributes.industry |
Branche des Kontos. |
timezone |
STRING | $.attributes.timezone |
Zeitzoneneinstellung für das Konto. |
preferred_currency |
STRING | $.attributes.preferred_currency |
Primäre Währung, die vom Konto verwendet wird. |
public_api_key |
STRING | $.attributes.public_api_key |
Öffentlicher API-Schlüssel (Website-ID) für clientseitige Integrationen. |
locale |
STRING | $.attributes.locale |
Gebietsschemaeinstellung (z.B. en-US). |
Gutscheine
Gutscheine für Rabatte und Werbeaktionen
- Tabellenname: Coupons
- Endpunkt:
/coupons - Klaviyo API-Referenz: Get Coupons
| Feldname | Typ | JSON-Pfad | Beschreibung |
|---|---|---|---|
type |
STRING | $.type |
Ressourcentyp (immer coupon). |
id |
STRING | $.id |
Eindeutige interne Kennung für den Gutschein. |
external_id |
STRING | $.attributes.external_id |
Externe Kennung (oft mit Name/ID identisch). |
description |
STRING | $.attributes.description |
Beschreibung des Gutscheinangebots. |
low_balance_threshold |
STRING | $.attributes.monitor_configuration.low_balance_threshold |
Schwellenwert für die Benachrichtigung über niedriges Guthaben. |
CouponCode
Individuelle, eindeutige Codes, die für bestimmte Gutscheine generiert werden.
- Tabellenname: CouponCode
- Endpunkt:
/coupon-codes - Klaviyo API-Referenz: Gutscheincodes abrufen
| Feldname | Typ | JSON-Pfad | Beschreibung |
|---|---|---|---|
type |
STRING | $.type |
Ressourcentyp (immer coupon-code). |
id |
STRING | $.id |
Eindeutige Kennung für diese spezifische Codeinstanz. |
unique_code |
STRING | $.attributes.unique_code |
Der tatsächliche alphanumerische Codestring. |
expires_at |
TIMESTAMP | $.attributes.expires_at |
Zeitstempel, der angibt, wann dieser Code abläuft. |
status |
STRING | $.attributes.status |
Status des Codes (z.B. ASSIGNED, UNASSIGNED). |
coupon_id |
STRING | $.relationships.coupon.data.id |
ID der übergeordneten Gutscheindefinition. |
Ereignisse
Aktivitätsereignisse, die für Profile erfasst werden (z.B. „Bestellung aufgegeben“, „Produkt angesehen“).
- Tabellenname: Events
- Endpunkt:
/events - Klaviyo API-Referenz: Get Events
| Feldname | Typ | JSON-Pfad | Beschreibung |
|---|---|---|---|
type |
STRING | $.type |
Ressourcentyp (immer event). |
id |
STRING | $.id |
Eindeutige Kennung für das Ereignis. |
timestamp |
FLOAT | $.attributes.timestamp |
Unix-Zeitstempel des Ereignisses. |
event_properties |
JSON | $.attributes.event_properties |
Benutzerdefinierte JSON-Eigenschaften, die für den Ereignistyp spezifisch sind (z.B. Artikel in der Bestellung). |
datetime |
TIMESTAMP | $.attributes.datetime |
ISO 8601-Zeitstempel des Ereignisses. |
uuid |
STRING | $.attributes.uuid |
Universell eindeutige Kennung für das Ereignis. |
profile_id |
STRING | $.relationships.profile.data.id |
ID des Profils (Kunden), das mit dem Ereignis verknüpft ist. |
metric_id |
STRING | $.relationships.metric.data.id |
ID der Messwertdefinition (Ereignistyp). |
attribution_ids |
REPEATED STRING | $.relationships.attributions.data[*].id |
IDs von Kampagnen/Abläufen, die diesem Ereignis zugeordnet sind. |
Flows
Automatisierte Marketingabläufe, die durch bestimmte Ereignisse oder Bedingungen ausgelöst werden.
- Tabellenname: Flows
- Endpunkt:
/flows - Klaviyo API-Referenz: Get Flows
| Feldname | Typ | JSON-Pfad | Beschreibung |
|---|---|---|---|
type |
STRING | $.type |
Ressourcentyp (immer flow). |
id |
STRING | $.id |
Eindeutige Kennung für den Ablauf. |
name |
STRING | $.attributes.name |
Name des Ablaufs. |
status |
STRING | $.attributes.status |
Betriebsstatus (z. B. „Live“, „Entwurf“) |
archived |
BOOLEAN | $.attributes.archived |
Gibt an, ob der Ablauf archiviert ist. |
created |
TIMESTAMP | $.attributes.created |
Zeitstempel der Erstellung. |
updated |
TIMESTAMP | $.attributes.updated |
Zeitstempel der letzten Änderung. |
trigger_type |
STRING | $.attributes.trigger_type |
Mechanismus, der den Ablauf auslöst (z.B. „Zur Liste hinzugefügt“, „Messwert“). |
flow_actions_ids |
REPEATED STRING | $.relationships.flow-actions.data[*].id |
IDs der Aktionen (Schritte) in diesem Ablauf. |
tag_ids |
REPEATED STRING | $.relationships.tags.data[*].id |
IDs von Tags, die diesem Ablauf zugewiesen sind. |
Formulare
Anmeldeformulare zum Erfassen von Abonnenteninformationen
- Tabellenname: Forms
- Endpunkt:
/forms - Klaviyo API-Referenz: Get Forms
| Feldname | Typ | JSON-Pfad | Beschreibung |
|---|---|---|---|
type |
STRING | $.type |
Ressourcentyp (immer form). |
id |
STRING | $.id |
Eindeutige Kennung des Formulars. |
name |
STRING | $.attributes.name |
Name des Formulars. |
status |
STRING | $.attributes.status |
Status des Formulars (z. B. „Live“, „Entwurf“) |
ab_test |
BOOLEAN | $.attributes.ab_test |
Gibt an, ob für das Formular ein A/B-Test ausgeführt wird. |
created_at |
TIMESTAMP | $.attributes.created_at |
Zeitstempel der Erstellung. |
updated_at |
TIMESTAMP | $.attributes.updated_at |
Zeitstempel der letzten Änderung. |
Bilder
Bilder, die in Klaviyo hochgeladen wurden, um sie in Kampagnen und Vorlagen zu verwenden.
- Tabellenname: Images
- Endpunkt:
/images - Klaviyo API-Referenz: Get Images
| Feldname | Typ | JSON-Pfad | Beschreibung |
|---|---|---|---|
type |
STRING | $.type |
Ressourcentyp (immer image). |
id |
STRING | $.id |
Eindeutige Kennung. |
name |
STRING | $.attributes.name |
Dateiname oder Name des Bildes. |
image_url |
STRING | $.attributes.image_url |
Öffentliche URL für den Zugriff auf das Bild. |
format |
STRING | $.attributes.format |
Bilddateiformat (z. B. JPEG, PNG) |
size |
FLOAT | $.attributes.size |
Dateigröße in Byte. |
hidden |
BOOLEAN | $.attributes.hidden |
Gibt an, ob das Image in der Benutzeroberfläche ausgeblendet ist. |
updated_at |
TIMESTAMP | $.attributes.updated_at |
Zeitstempel der letzten Änderung. |
Listen
Statische Listen von Kontakten/Profilen.
- Tabellenname: Listen
- Endpunkt:
/lists - Klaviyo API-Referenz: Get Lists
| Feldname | Typ | JSON-Pfad | Beschreibung |
|---|---|---|---|
type |
STRING | $.type |
Ressourcentyp (immer list). |
id |
STRING | $.id |
Eindeutige Kennung für die Liste. |
name |
STRING | $.attributes.name |
Name der Kontaktliste. |
created |
TIMESTAMP | $.attributes.created |
Zeitstempel der Erstellung. |
updated |
TIMESTAMP | $.attributes.updated |
Zeitstempel der letzten Änderung. |
opt_in_process |
STRING | $.attributes.opt_in_process |
Opt-In-Einstellung (z.B. „singleoptin“ oder „doubleoptin“). |
tag_ids |
REPEATED STRING | $.relationships.tags.data[*].id |
IDs der Tags, die dieser Liste zugewiesen sind. |
flow_triggers_ids |
REPEATED STRING | $.relationships.flow-triggers.data[*].id |
IDs von Abläufen, die durch das Hinzufügen von Profilen zu dieser Liste ausgelöst werden. |
Messwerte
Arten von Ereignissen, die erfasst werden können (z.B. „E-Mail erhalten“).
- Tabellenname: Metrics
- Endpunkt:
/metrics - Klaviyo API-Referenz: Get Metrics
| Feldname | Typ | JSON-Pfad | Beschreibung |
|---|---|---|---|
type |
STRING | $.type |
Ressourcentyp (immer metric). |
id |
STRING | $.id |
Eindeutige Kennung (z.B. 6-stelliger Code für generische, lange UUID für benutzerdefinierte). |
name |
STRING | $.attributes.name |
Menschenlesbarer Name (z.B. „Bestellung aufgegeben“). |
created |
TIMESTAMP | $.attributes.created |
Zeitstempel der Erstellung. |
updated |
TIMESTAMP | $.attributes.updated |
Zeitstempel der letzten Änderung. |
integration |
JSON | $.attributes.integration |
Informationen zur Integration, die diesen Messwert bereitstellt (z.B. Name, Kategorie, Bild). |
flow_triggers_ids |
REPEATED STRING | $.relationships.flow-triggers.data[*].id |
IDs von Abläufen, die durch diesen Messwert ausgelöst werden. |
Profile
Umfassende Kundenprofile mit Attributen und Aktivitätsverlauf.
- Tabellenname: Profiles
- Endpunkt:
/profiles - Klaviyo API-Referenz: Get Profiles
| Feldname | Typ | JSON-Pfad | Beschreibung |
|---|---|---|---|
type |
STRING | $.type |
Ressourcentyp (immer profile). |
id |
STRING | $.id |
Eindeutige Klaviyo-ID für das Profil. |
email |
STRING | $.attributes.email |
Primäre E‑Mail-Adresse. |
phone_number |
STRING | $.attributes.phone_number |
Telefonnummer im E.164-Format. |
external_id |
STRING | $.attributes.external_id |
ID aus einem externen System. |
first_name |
STRING | $.attributes.first_name |
Vorname |
last_name |
STRING | $.attributes.last_name |
Nachname |
organization |
STRING | $.attributes.organization |
Name des Unternehmens oder der Organisation. |
locale |
STRING | $.attributes.locale |
Sprachcode/Spracheinstellung. |
title |
STRING | $.attributes.title |
Stellenbezeichnung. |
image |
STRING | $.attributes.image |
URL des Profilbilds. |
created |
TIMESTAMP | $.attributes.created |
Zeitstempel der Profilerstellung. |
updated |
TIMESTAMP | $.attributes.updated |
Zeitstempel der letzten Aktualisierung. |
last_event_date |
TIMESTAMP | $.attributes.last_event_date |
Zeitstempel des letzten Ereignisses. |
address1 |
STRING | $.attributes.location.address1 |
Adresszeile 1. |
address2 |
STRING | $.attributes.location.address2 |
Adresszeile 2. |
city |
STRING | $.attributes.location.city |
Stadt: |
country |
STRING | $.attributes.location.country |
Land. |
latitude |
STRING | $.attributes.location.latitude |
Breitengradkoordinaten. |
longitude |
STRING | $.attributes.location.longitude |
Längengradkoordinaten. |
region |
STRING | $.attributes.location.region |
Bundesland oder Region. |
zip |
STRING | $.attributes.location.zip |
Postleitzahl. |
timezone |
STRING | $.attributes.location.timezone |
Zeitzone. |
ip |
STRING | $.attributes.location.ip |
ohne dass eine externe IP-Adresse erforderlich ist. |
properties |
JSON | $.attributes.properties |
Schlüssel/Wert-Paare für benutzerdefinierte Eigenschaften. |
email_marketing_can_receive_email_marketing |
BOOLEAN | $.attributes.subscriptions.email.marketing.can_receive_email_marketing |
Gibt an, ob das Profil E‑Mail-Marketing erhalten kann. |
email_marketing_consent |
STRING | $.attributes.subscriptions.email.marketing.consent |
Einwilligungsstatus (z. B. SUBSCRIBED, UNSUBSCRIBED) |
email_marketing_consent_timestamp |
TIMESTAMP | $.attributes.subscriptions.email.marketing.consent_timestamp |
Wann die Einwilligung erteilt wurde. |
email_marketing_last_updated |
TIMESTAMP | $.attributes.subscriptions.email.marketing.last_updated |
Wann die Einwilligung zum Erhalt von E‑Mails zuletzt aktualisiert wurde. |
email_marketing_method |
STRING | $.attributes.subscriptions.email.marketing.method |
Methode der Einwilligung (z.B. FORMULAR). |
email_marketing_method_detail |
STRING | $.attributes.subscriptions.email.marketing.method_detail |
Spezifische Quelle der Methode. |
email_marketing_custom_method_detail |
STRING | $.attributes.subscriptions.email.marketing.custom_method_detail |
Benutzerdefinierte Details für die Einwilligungsmethode. |
email_marketing_double_optin |
BOOLEAN | $.attributes.subscriptions.email.marketing.double_optin |
Gibt an, ob das Double Opt-In abgeschlossen wurde. |
sms_marketing_can_receive_sms_marketing |
BOOLEAN | $.attributes.subscriptions.sms.marketing.can_receive_sms_marketing |
Gibt an, ob das Profil SMS-Marketing erhalten kann. |
sms_marketing_consent |
STRING | $.attributes.subscriptions.sms.marketing.consent |
SMS-Einwilligungsstatus |
sms_marketing_consent_timestamp |
TIMESTAMP | $.attributes.subscriptions.sms.marketing.consent_timestamp |
Wann die Einwilligung zum Erhalt von SMS erteilt wurde. |
sms_marketing_last_updated |
TIMESTAMP | $.attributes.subscriptions.sms.marketing.last_updated |
Wann die SMS-Einwilligung zuletzt aktualisiert wurde. |
sms_marketing_method |
STRING | $.attributes.subscriptions.sms.marketing.method |
Methode zur Einholung der Einwilligung für SMS. |
sms_marketing_method_detail |
STRING | $.attributes.subscriptions.sms.marketing.method_detail |
Details zur SMS-Einwilligungsmethode. |
sms_transactional_can_receive_sms_transactional |
BOOLEAN | $.attributes.subscriptions.sms.transactional.can_receive_sms_transactional |
Gibt an, ob das Profil transaktionsbezogene SMS empfangen kann. |
sms_transactional_consent |
STRING | $.attributes.subscriptions.sms.transactional.consent |
Einwilligungsstatus für transaktionale SMS. |
sms_transactional_consent_timestamp |
TIMESTAMP | $.attributes.subscriptions.sms.transactional.consent_timestamp |
Wann die Einwilligung zur Transaktion erteilt wurde. |
sms_transactional_last_updated |
TIMESTAMP | $.attributes.subscriptions.sms.transactional.last_updated |
Wann der Transaktionsstatus zuletzt aktualisiert wurde. |
sms_transactional_method |
STRING | $.attributes.subscriptions.sms.transactional.method |
Transaktions-SMS-Methode. |
sms_transactional_method_detail |
STRING | $.attributes.subscriptions.sms.transactional.method_detail |
Details zur Transaktions-SMS-Methode. |
mobile_push_can_receive_push_marketing |
BOOLEAN | $.attributes.subscriptions.mobile_push.marketing.can_receive_push_marketing |
Gibt an, ob das Profil Push-Marketing erhalten kann. |
mobile_push_consent |
STRING | $.attributes.subscriptions.mobile_push.marketing.consent |
Einwilligungsstatus übertragen. |
mobile_push_consent_timestamp |
TIMESTAMP | $.attributes.subscriptions.mobile_push.marketing.consent_timestamp |
Wann die Einwilligung für Push-Benachrichtigungen erteilt wurde. |
predictive_analytics_historic_number_of_orders |
FLOAT | $.attributes.predictive_analytics.historic_number_of_orders |
Gesamtzahl der bisherigen Bestellungen. |
predictive_analytics_predicted_number_of_orders |
FLOAT | $.attributes.predictive_analytics.predicted_number_of_orders |
Prognostizierte zukünftige Bestellungen. |
predictive_analytics_average_days_between_orders |
FLOAT | $.attributes.predictive_analytics.average_days_between_orders |
Durchschnittliche Anzahl von Tagen zwischen Bestellungen. |
predictive_analytics_average_order_value |
FLOAT | $.attributes.predictive_analytics.average_order_value |
Bisheriger durchschnittlicher Bestellwert. |
predictive_analytics_historic_clv |
FLOAT | $.attributes.predictive_analytics.historic_clv |
Historischer Customer Lifetime Value. |
predictive_analytics_predicted_clv |
FLOAT | $.attributes.predictive_analytics.predicted_clv |
Prognostizierter Customer Lifetime Value. |
predictive_analytics_total_clv |
FLOAT | $.attributes.predictive_analytics.total_clv |
Historischer und prognostizierter CLV. |
predictive_analytics_churn_probability |
FLOAT | $.attributes.predictive_analytics.churn_probability |
Abwanderungswahrscheinlichkeit (0–1). |
predictive_analytics_expected_date_of_next_order |
TIMESTAMP | $.attributes.predictive_analytics.expected_date_of_next_order |
Prognostiziertes Datum der nächsten Bestellung. |
email_marketing_suppression_reason |
REPEATED JSON | $.attributes.subscriptions.email.marketing.suppression[*] |
Gründe für die Unterdrückung von E‑Mails (z.B. zurückgewiesen). |
email_marketing_list_suppressions_reason |
REPEATED JSON | $.attributes.subscriptions.email.marketing.list_suppressions[*] |
Listenspezifische Gründe für die Unterdrückung. |
push_tokens_ids |
REPEATED STRING | $.relationships.push-tokens.data[*].id |
Verknüpfte Push-Token-IDs. |
Rezensionen
Von Kunden eingereichte Rezensionen
- Tabellenname: Reviews
- Endpunkt:
/reviews - Klaviyo API-Referenz: Get Reviews
| Feldname | Typ | JSON-Pfad | Beschreibung |
|---|---|---|---|
type |
STRING | $.type |
Ressourcentyp (immer review). |
id |
STRING | $.id |
Eindeutige Kennung für die Rezension. |
email |
STRING | $.attributes.email |
E‑Mail-Adresse des Prüfers. |
value |
STRING | $.attributes.status.value |
Statuswert (z. B. „veröffentlicht“, „abgelehnt“) |
reason |
STRING | $.attributes.status.rejection_reason.reason |
Grund für die Ablehnung, falls zutreffend. |
status_explanation |
STRING | $.attributes.status.rejection_reason.status_explanation |
Detaillierte Erläuterung des Status. |
verified |
BOOLEAN | $.attributes.verified |
Gibt an, ob der Kauf bestätigt wurde. |
review_type |
STRING | $.attributes.review_type |
Art der Rezension (z.B. Rezension). |
created |
TIMESTAMP | $.attributes.created |
Zeitstempel der Erstellung. |
updated |
TIMESTAMP | $.attributes.updated |
Zeitstempel der letzten Änderung. |
images |
REPEATED STRING | $.attributes.images[*] |
URLs von Bildern, die der Rezension angehängt sind. |
product_url |
STRING | $.attributes.product.url |
URL des rezensierten Produkts. |
product_name |
STRING | $.attributes.product.name |
Name des Produkts. |
product_image_url |
STRING | $.attributes.product.image_url |
Bild-URL des Produkts. |
product_external_id |
STRING | $.attributes.product.external_id |
Externe ID des Produkts. |
rating |
INTEGER | $.attributes.rating |
Bewertung. |
author |
STRING | $.attributes.author |
Name des Rezensenten. |
content |
STRING | $.attributes.content |
Textinhalt der Rezension. |
title |
STRING | $.attributes.title |
Titel der Rezension. |
smart_quote |
STRING | $.attributes.smart_quote |
Hervorgehobenes Zitat aus der Rezension. |
public_reply_content |
STRING | $.attributes.public_reply.content |
Inhalt der öffentlichen Antwort des Händlers. |
public_reply_author |
STRING | $.attributes.public_reply.author |
Autor der Antwort. |
public_reply_updated |
STRING | $.attributes.public_reply.updated |
Zeitstempel der Antwortaktualisierung. |
event_ids |
REPEATED STRING | $.relationships.events.data[*].id |
Zugehörige Ereignis-IDs. |
Segmente
Dynamische Gruppen von Profilen, die auf bestimmten Kriterien basieren.
- Tabellenname: Segments
- Endpunkt:
/segments - Klaviyo API-Referenz: Get Segments
| Feldname | Typ | JSON-Pfad | Beschreibung |
|---|---|---|---|
type |
STRING | $.type |
Ressourcentyp (immer segment). |
id |
STRING | $.id |
Eindeutige Kennung für das Segment. |
name |
STRING | $.attributes.name |
Segment name. |
created |
TIMESTAMP | $.attributes.created |
Zeitstempel der Erstellung. |
updated |
TIMESTAMP | $.attributes.updated |
Zeitstempel der letzten Änderung. |
is_active |
BOOLEAN | $.attributes.is_active |
Gibt an, ob das Segment aktiv ist. |
is_processing |
BOOLEAN | $.attributes.is_processing |
Gibt an, ob das Segment verarbeitet wird. |
is_starred |
BOOLEAN | $.attributes.is_starred |
Gibt an, ob das Segment markiert/als Favorit hinzugefügt wurde. |
tag_ids |
REPEATED STRING | $.relationships.tags.data[*].id |
IDs der zugehörigen Tags. |
flow_triggers_ids |
REPEATED STRING | $.relationships.flow-triggers.data[*].id |
IDs von Abläufen, die durch dieses Segment ausgelöst werden. |
condition_groups |
REPEATED ConditionGroup | $.attributes.definition.condition_groups[*] |
Gruppen von logischen Bedingungen, die das Segment definieren. |
ConditionGroup
| Feldname | Typ | JSON-Pfad | Beschreibung |
|---|---|---|---|
conditions |
REPEATED-Bedingung | conditions[*] |
Liste der einzelnen Bedingungen innerhalb der Gruppe. |
Bedingung
| Feldname | Typ | JSON-Pfad | Beschreibung |
|---|---|---|---|
type |
STRING | type |
Typ der Bedingung (z.B. profile-property). |
value |
JSON | N/A |
Bedingungswert/-konfiguration. |
Tags
Tags, die zum Organisieren von Kampagnen, Abläufen und Listen verwendet werden.
- Tabellenname: Tags
- Endpunkt:
/tags - Klaviyo API-Referenz: Get Tags
| Feldname | Typ | JSON-Pfad | Beschreibung |
|---|---|---|---|
type |
STRING | $.type |
Ressourcentyp (immer tag). |
id |
STRING | $.id |
Eindeutige Tag-ID. |
name |
STRING | $.attributes.name |
Name des Tags. |
tag_group_id |
STRING | $.relationships.tag-group.data.id |
ID der Tag-Gruppe, zu der dieses Tag gehört. |
Vorlagen
E‑Mail- und Nachrichtenvorlagen.
- Tabellenname: Templates
- Endpunkt:
/templates - Klaviyo API-Referenz: Get Templates
| Feldname | Typ | JSON-Pfad | Beschreibung |
|---|---|---|---|
type |
STRING | $.type |
Ressourcentyp (immer template). |
id |
STRING | $.id |
Eindeutige Kennung. |
name |
STRING | $.attributes.name |
Vorlagenname. |
editor_type |
STRING | $.attributes.editor_type |
Verwendeter Editor (z. B. Drag-and-Drop) |
html |
STRING | $.attributes.html |
HTML-Inhalt |
text |
STRING | $.attributes.text |
Textversion der Vorlage. |
| amp | STRING | $.attributes.amp |
AMP-Version der Vorlage. |
created |
TIMESTAMP | $.attributes.created |
Zeitstempel der Erstellung. |
updated |
TIMESTAMP | $.attributes.updated |
Zeitstempel der letzten Aktualisierung. |
WebFeeds
Webfeeds, die zum Einfügen von Inhalten in Nachrichten verwendet werden.
- Tabellenname: WebFeeds
- Endpunkt:
/web-feeds - Klaviyo API-Referenz: Webfeeds abrufen
| Feldname | Typ | JSON-Pfad | Beschreibung |
|---|---|---|---|
type |
STRING | $.type |
Ressourcentyp (immer web-feed). |
id |
STRING | $.id |
Eindeutige Kennung. |
name |
STRING | $.attributes.name |
Feed name. |
url |
STRING | $.attributes.url |
Feed-Quell-URL. |
request_method |
STRING | $.attributes.request_method |
HTTP-Methode (GET/POST). |
content_type |
STRING | $.attributes.content_type |
Inhaltstyp (z.B. JSON). |
status |
STRING | $.attributes.status |
Status des Feeds. |
created |
TIMESTAMP | $.attributes.created |
Zeitstempel der Erstellung. |
updated |
TIMESTAMP | $.attributes.updated |
Zeitstempel der letzten Aktualisierung. |
DataSources
In Klaviyo integrierte Datenquellen.
- Tabellenname: DataSources
- Endpunkt:
/data-sources - Klaviyo API-Referenz: Get Data Sources
| Feldname | Typ | JSON-Pfad | Beschreibung |
|---|---|---|---|
type |
STRING | $.type |
Ressourcentyp (immer data-source). |
id |
STRING | $.id |
Eindeutige Kennung. |
title |
STRING | $.attributes.title |
Titel der Datenquelle. |
visibility |
STRING | $.attributes.visibility |
Sichtbarkeitsstufe. |
description |
STRING | $.attributes.description |
Textzeile. |
Kampagnen
Marketingkampagnen, die an Listen oder Segmente gesendet werden.
- Tabellenname: Campaigns
- Endpunkt:
/campaigns - Klaviyo API-Referenz: Get Campaigns
| Feldname | Typ | JSON-Pfad | Beschreibung |
|---|---|---|---|
type |
STRING | $.type |
Ressourcentyp (immer campaign). |
id |
STRING | $.id |
Eindeutige Kennung. |
name |
STRING | $.attributes.name |
Kampagnenname. |
status |
STRING | $.attributes.status |
Kampagnenstatus (z. B. „Gesendet“, „Wird geplant“) |
archived |
BOOLEAN | $.attributes.archived |
Gibt an, ob die Kampagne archiviert ist. |
included |
REPEATED STRING | $.attributes.audiences.included |
IDs der eingeschlossenen Listen/Segmente. |
excluded |
REPEATED STRING | $.attributes.audiences.excluded |
IDs der ausgeschlossenen Listen/Segmente. |
send_options |
JSON | $.attributes.send_options |
Konfiguration für das Senden (z.B. intelligentes Senden). |
tracking_options |
JSON | $.attributes.tracking_options |
Konfiguration für das Tracking (z.B. UTM-Parameter). |
send_strategy |
JSON | $.attributes.send_strategy |
Strategie für die Lieferdauer. |
created_at |
TIMESTAMP | $.attributes.created_at |
Zeitstempel der Erstellung. |
scheduled_at |
TIMESTAMP | $.attributes.scheduled_at |
Wann die Kampagne gesendet werden soll. |
updated_at |
TIMESTAMP | $.attributes.updated_at |
Zeitstempel der letzten Aktualisierung. |
send_time |
TIMESTAMP | $.attributes.send_time |
Tatsächliche Sendezeit. |
tag_ids |
REPEATED STRING | $.relationships.tags.data[*].id |
IDs der zugehörigen Tags. |
campaign_message_ids |
REPEATED STRING | $.relationships.campaign-messages.data[*].id |
IDs der in dieser Kampagne enthaltenen Nachrichten. |
CampaignMessages
Einzelne Nachrichten (E‑Mail/SMS) innerhalb einer Kampagne.
- Tabellenname: CampaignMessages
- Endpunkt:
/campaign-messages - Klaviyo API-Referenz: Get Campaign Message
| Feldname | Typ | JSON-Pfad | Beschreibung |
|---|---|---|---|
type |
STRING | $.type |
Ressourcentyp (immer campaign-message). |
id |
STRING | $.id |
Eindeutige Kennung. |
definition |
JSON | $.attributes.definition |
Inhalt und Konfiguration der Nachricht. |
send_times |
REPEATED JSON | $.attributes.send_times[*] |
Geplante Sendezeiten. |
created_at |
TIMESTAMP | $.attributes.created_at |
Zeitstempel der Erstellung. |
updated_at |
TIMESTAMP | $.attributes.updated_at |
Zeitstempel der letzten Aktualisierung. |
campaign_id |
STRING | $.relationships.campaign.data.id |
ID der übergeordneten Kampagne. |
template_id |
STRING | $.relationships.template.data.id |
ID der verwendeten Vorlage. |
image_id |
STRING | $.relationships.image.data.id |
ID des angehängten Bildes. |
Kategorien
Produktkategorien aus Ihrem Katalog.
- Tabellenname: Categories
- Endpunkt:
/catalog-categories - Klaviyo API-Referenz: Get Catalog Categories
| Feldname | Typ | JSON-Pfad | Beschreibung |
|---|---|---|---|
type |
STRING | $.type |
Ressourcentyp. |
id |
STRING | $.id |
Eindeutige Kennung. |
name |
STRING | $.attributes.name |
Kategoriename. |
external_id |
STRING | $.attributes.external_id |
ID des externen Systems. |
updated |
TIMESTAMP | $.attributes.updated |
Zeitstempel der letzten Aktualisierung. |
Elemente
Einzelne Produkte oder Artikel in Ihrem Katalog.
- Tabellenname: Items
- Endpunkt:
/catalog-items - Klaviyo API-Referenz: Get Catalog Items
| Feldname | Typ | JSON-Pfad | Beschreibung |
|---|---|---|---|
type |
STRING | $.type |
Ressourcentyp. |
id |
STRING | $.id |
Eindeutige Kennung. |
external_id |
STRING | $.attributes.external_id |
ID des externen Systems. |
title |
STRING | $.attributes.title |
Titel/Name des Artikels. |
description |
STRING | $.attributes.description |
Beschreibung verfügbar. |
price |
FLOAT | $.attributes.price |
Preis des Artikels. |
url |
STRING | $.attributes.url |
URL zum Element. |
image_full_url |
STRING | $.attributes.image_full_url |
URL des Bildes in voller Größe. |
image_thumbnail_url |
STRING | $.attributes.image_thumbnail_url |
URL des Thumbnail-Bilds. |
images |
REPEATED STRING | $.attributes.images[*] |
Liste zusätzlicher Bild-URLs. |
custom_metadata |
JSON | $.attributes.custom_metadata |
Benutzerdefinierte Metadaten-Schlüssel/Wert-Paare. |
published |
BOOLEAN | $.attributes.published |
Publikationsstatus. |
created |
TIMESTAMP | $.attributes.created |
Zeitstempel der Erstellung. |
updated |
TIMESTAMP | $.attributes.updated |
Zeitstempel der letzten Aktualisierung. |
variants_ids |
REPEATED STRING | $.relationships.variants.data[*].id |
IDs der Varianten für diesen Artikel. |
Varianten
Spezifische Varianten von Katalogartikeln (z.B. Größen, Farben).
- Tabellenname: Variants
- Endpunkt:
/catalog-variants - Klaviyo API-Referenz: Get Catalog Variants
| Feldname | Typ | JSON-Pfad | Beschreibung |
|---|---|---|---|
type |
STRING | $.type |
Ressourcentyp. |
id |
STRING | $.id |
Eindeutige Kennung. |
external_id |
STRING | $.attributes.external_id |
ID des externen Systems. |
title |
STRING | $.attributes.title |
Titel der Variante. |
description |
STRING | $.attributes.description |
Beschreibung verfügbar. |
sku |
STRING | $.attributes.sku |
Artikelnummer. |
inventory_policy |
FLOAT | $.attributes.inventory_policy |
Richtlinie für die Inventarverwaltung. |
inventory_quantity |
FLOAT | $.attributes.inventory_quantity |
Aktuelle Bestandsmenge. |
price |
FLOAT | $.attributes.price |
Preis. |
url |
STRING | $.attributes.url |
URL zur Variante. |
image_full_url |
STRING | $.attributes.image_full_url |
Vollständige Bild-URL verfügbar (boolescher Wert). |
image_thumbnail_url |
STRING | $.attributes.image_thumbnail_url |
URL des Thumbnail-Bilds. |
images |
REPEATED STRING | $.attributes.images[*] |
Liste der Bilder. |
published |
BOOLEAN | $.attributes.published |
Publikationsstatus. |
created |
TIMESTAMP | $.attributes.created |
Zeitstempel der Erstellung. |
updated |
TIMESTAMP | $.attributes.updated |
Zeitstempel der letzten Aktualisierung. |
FlowActions
Mit einem Ablauf verknüpfte Ablaufaktionen.
- Tabellenname: FlowActions
- Endpunkt:
/flows/{id}/flow-actions - Klaviyo API-Referenz: Get Flow Actions
| Feldname | Typ | JSON-Pfad | Beschreibung |
|---|---|---|---|
type |
STRING | $.type |
Ressourcentyp. Immer flow-action. |
id |
STRING | $.id |
Eindeutige Kennung für die Ablaufaktion. |
created |
TIMESTAMP | $.attributes.created |
Zeitstempel der Erstellung. |
updated |
TIMESTAMP | $.attributes.updated |
Zeitstempel der letzten Änderung. |
message_id |
STRING | $.attributes.definition.id |
Eindeutige ID für die Definition der Aktionsnachricht. |
message_temporary_id |
STRING | $.attributes.definition.temporary_id |
Temporäre ID, die der Nachrichtendefinition zugewiesen ist. |
message_type |
STRING | $.attributes.definition.type |
Nachrichtentyp, z. B. email, sms. |
condition_groups |
REPEATED ConditionGroup | $.attributes.definition.data.action_output_filter.condition_groups[*] |
Bedingungen, die mit dem Ausgabefilter der Ablaufaktion verknüpft sind. |
next_if_true |
STRING | $.attributes.definition.links.next_if_true |
ID der nächsten Ablaufaktion, wenn die Bedingung als true ausgewertet wird. |
next_if_false |
STRING | $.attributes.definition.links.next_if_false |
ID der nächsten Ablaufaktion, wenn die Bedingung als false ausgewertet wird. |
FormVersions
Formularversionen für ein bestimmtes Formular.
- Tabellenname: FormVersions
- Endpunkt:
/forms/{id}/form-versions - Klaviyo API-Referenz: Get Form Versions
| Feldname | Typ | JSON-Pfad | Beschreibung |
|---|---|---|---|
type |
STRING | $.type |
Ressourcentyp. Immer form-version. |
id |
STRING | $.id |
Eindeutige Kennung für die Formularversion. |
form_type |
STRING | $.attributes.form_type |
Art des Formulars, z. B. popup, embed, banner. |
variation_name |
STRING | $.attributes.variation_name |
Name der Formularvariante. |
ab_test |
JSON | $.attributes.ab_test |
Konfigurations- und Variationseinstellungen für A/B-Tests |
status |
STRING | $.attributes.status |
Betriebsstatus der Formularversion, z. B. draft, live. |
created_at |
TIMESTAMP | $.attributes.created_at |
Zeitstempel der Erstellung. |
updated_at |
TIMESTAMP | $.attributes.updated_at |
Zeitstempel der letzten Änderung. |
PushTokens
Push-Tokens, die mit Profilen mobiler Apps für Push-Benachrichtigungen verknüpft sind.
- Tabellenname: PushTokens
- Endpunkt:
/push-tokens - Klaviyo API-Referenz: Get Push Tokens
| Feldname | Typ | JSON-Pfad | Beschreibung |
|---|---|---|---|
type |
STRING | $.type |
Ressourcentyp. Immer push-token. |
id |
STRING | $.id |
Eindeutige Kennung für das Push-Token. |
created |
TIMESTAMP | $.attributes.created |
Zeitstempel der Erstellung. |
token |
STRING | $.attributes.token |
Push-Token-String des Geräts. |
enablement_status |
STRING | $.attributes.enablement_status |
Status der Aktivierung von Push-Benachrichtigungen, z. B. AUTHORIZED, UNAUTHORIZED. |
platform |
STRING | $.attributes.platform |
Mobile Plattform, z. B. ios, android. |
vendor |
STRING | $.attributes.vendor |
Anbieter von Dienstleistungen, z. B. apns, fcm. |
background |
STRING | $.attributes.background |
Status der Hintergrundaktualisierung für Push-Benachrichtigungen. |
recorded_date |
TIMESTAMP | $.attributes.recorded_date |
Datum, an dem das Push-Token aufgezeichnet wurde. |
metadata |
JSON | $.attributes.metadata |
Benutzerdefinierte Geräte- oder Push-Token-Metadaten. |
profile_id |
STRING | $.relationships.profile.data.id |
ID des Kundenprofils, das diesem Push-Token zugeordnet ist. |
TagGroups
Tag-Gruppen, die zum Organisieren und Kategorisieren von Tags verwendet werden.
- Tabellenname: TagGroups
- Endpunkt:
/tag-groups - Klaviyo API-Referenz: Get Tag Groups
| Feldname | Typ | JSON-Pfad | Beschreibung |
|---|---|---|---|
type |
STRING | $.type |
Ressourcentyp. Immer tag-group. |
id |
STRING | $.id |
Eindeutige Kennung für die Tag-Gruppe. |
name |
STRING | $.attributes.name |
Name der Tag-Gruppe. |
exclusive |
BOOLEAN | $.attributes.exclusive |
Gibt an, ob sich Tags innerhalb dieser Gruppe gegenseitig ausschließen. |
default |
BOOLEAN | $.attributes.default |
Gibt an, ob dies die Standard-Tag-Gruppe für das Konto ist. |
UniversalContent
Wiederverwendbare universelle Inhaltsblöcke für Nachrichten und Vorlagen.
- Tabellenname: UniversalContent
- Endpunkt:
/template-universal-content - Klaviyo API-Referenz: Get Universal Content
| Feldname | Typ | JSON-Pfad | Beschreibung |
|---|---|---|---|
type |
STRING | $.type |
Ressourcentyp. Immer template-universal-content. |
id |
STRING | $.id |
Eindeutige Kennung für den universellen Inhaltsblock. |
name |
STRING | $.attributes.name |
Name des universellen Inhaltsblocks. |
definition_content_type |
STRING | $.attributes.definition.content_type |
Inhaltstyp der Definition, z. B. block, template. |
definition_type |
STRING | $.attributes.definition.type |
Komponententyp des Inhalts, z. B. text, button, image. |
definition_data |
JSON | $.attributes.definition.data |
Strukturdaten und Nutzlast der Inhaltsdefinition. |
created |
TIMESTAMP | $.attributes.created |
Zeitstempel der Erstellung. |
updated |
TIMESTAMP | $.attributes.updated |
Zeitstempel der letzten Änderung. |
screenshot_status |
STRING | $.attributes.screenshot_status |
Status der Erstellung von Vorschauscreenshots, z. B. completed, pending. |
screenshot_url |
STRING | $.attributes.screenshot_url |
Öffentliche URL des Screenshots der Inhaltsvorschau. |
MetricProperties
Für bestimmte Messwerte definierte Attribute und strukturelle Attribute.
- Tabellenname: MetricProperties
- Endpunkt:
/metrics/{id}/metric-properties - Klaviyo API-Referenz: Get Metric Properties
| Feldname | Typ | JSON-Pfad | Beschreibung |
|---|---|---|---|
type |
STRING | $.type |
Ressourcentyp. Immer metric-property. |
id |
STRING | $.id |
Eindeutige Kennung für die Messwert-Property. |
sample_values |
JSON | $.attributes.sample_values |
Beispielhafte Datenwerte, die für dieses Messwertattribut erfasst wurden. |
label |
STRING | $.attributes.label |
Menschenlesbares Label für das Attribut. |
property |
STRING | $.attributes.property |
Schlüsselname des Ereignisattributs. |
inferred_type |
STRING | $.attributes.inferred_type |
Von Klaviyo für dieses Attribut abgeleiteter Datentyp, z. B. string, boolean, numeric. |
metric_id |
STRING | $.relationships.metric.data.id |
ID der übergeordneten Messwertdefinition. |
TrackingSettings
UTM-Tracking-Parameter auf Kontoebene für Kampagnen und Abläufe.
- Tabellenname: TrackingSettings
- Endpunkt:
/tracking-settings - Klaviyo API-Referenz: Get Tracking Settings
| Feldname | Typ | JSON-Pfad | Beschreibung |
|---|---|---|---|
type |
STRING | $.type |
Ressourcentyp. Immer tracking-setting. |
id |
STRING | $.id |
Eindeutige Kennung für die Tracking-Einstellungen. |
auto_add_parameters |
BOOLEAN | $.attributes.auto_add_parameters |
Gibt an, ob UTM-Parameter automatisch zu Nachrichtenlinks hinzugefügt werden. |
utm_source |
UtmParameter | $.attributes.utm_source |
Konfiguration für _utm_source parameter in Abläufen und Kampagnen. |
utm_medium |
UtmParameter | $.attributes.utm_medium |
Konfiguration für _utm_medium parameter in Abläufen und Kampagnen. |
utm_campaign |
UtmParameter | $.attributes.utm_campaign |
Konfiguration für den Parameter _utm_campaign in Abläufen und Kampagnen. |
utm_id |
UtmParameter | $.attributes.utm_id |
Konfiguration für den Parameter _utm_id in Abläufen und Kampagnen. |
utm_term |
UtmParameter | $.attributes.utm_term |
Konfiguration für den Parameter _utm_term in Abläufen und Kampagnen. |
custom_parameters |
REPEATED CustomParameter | $.attributes.custom_parameters |
Benutzerdefinierte Tracking-Parameter, die an Kampagnen- und Ablauf-Links angehängt werden. |
UtmParameter
| Feldname | Typ | JSON-Pfad | Beschreibung |
|---|---|---|---|
flow |
ParameterContext | flow |
Kontext der UTM-Parametereinstellungen für Abläufe. |
campaign |
ParameterContext | campaign |
Kontext der UTM-Parametereinstellungen für Kampagnen. |
ParameterContext
| Feldname | Typ | JSON-Pfad | Beschreibung |
|---|---|---|---|
type |
STRING | type |
Ressourcentyp. |
value |
STRING | value |
Wert der Parametervorlage oder Attributschlüssel, z. B. emailsubject, campaignid. |
CustomParameter
| Feldname | Typ | JSON-Pfad | Beschreibung |
|---|---|---|---|
flow |
ParameterContext | flow |
Kontext für benutzerdefinierte Tracking-Parameter für Abläufe. |
campaign |
ParameterContext | campaign |
Kontext für benutzerdefinierte Tracking-Parameter für Kampagnen. |
name |
STRING | name |
Name des benutzerdefinierten Tracking-Parameters. |