Documentation de référence sur le modèle de données Klaviyo

Cette page liste les données transférées vers BigQuery lorsque vous exécutez un transfert de données Klaviyo. Les données sont organisées en tables qui listent chaque nom de champ, son type de données de destination associé et le chemin JSON à partir des données sources.

Comptes

Informations et métadonnées du compte Klaviyo.

  • Nom de la table : Accounts
  • Point de terminaison : /accounts
  • Documentation de référence de l'API Klaviyo : Get Accounts
Nom du champ Type Chemin d'accès JSON Description
type STRING $.type Type de ressource (toujours account).
id STRING $.id Identifiant unique du compte.
test_account STRING $.attributes.test_account Indique s'il s'agit d'un compte test.
default_sender_name STRING $.attributes.contact_information.default_sender_name Nom par défaut utilisé comme expéditeur des e-mails.
default_sender_email STRING $.attributes.contact_information.default_sender_email Adresse e-mail par défaut utilisée comme expéditeur.
website_url STRING $.attributes.contact_information.website_url URL du site Web de l'organisation.
organization_name STRING $.attributes.contact_information.organization_name Nom de l'organisation.
address1 STRING $.attributes.contact_information.street_address.address1 Adresse postale (ligne 1).
address2 STRING $.attributes.contact_information.street_address.address2 Adresse postale (ligne 2).
city STRING $.attributes.contact_information.street_address.city Ville de l'organisation.
region STRING $.attributes.contact_information.street_address.region État, province ou région.
country STRING $.attributes.contact_information.street_address.country Pays.
zip STRING $.attributes.contact_information.street_address.zip Code postal.
industry STRING $.attributes.industry Secteur d'activité du compte.
timezone STRING $.attributes.timezone Paramètre de fuseau horaire du compte.
preferred_currency STRING $.attributes.preferred_currency Devise principale utilisée par le compte.
public_api_key STRING $.attributes.public_api_key Clé API publique (ID du site) pour les intégrations côté client.
locale STRING $.attributes.locale Paramètre régional (par exemple, en-US).

Bons de réduction

Bons de réduction et promotions.

  • Nom de la table : Coupons
  • Point de terminaison : /coupons
  • Documentation de référence de l'API Klaviyo : Get Coupons
Nom du champ Type Chemin d'accès JSON Description
type STRING $.type Type de ressource (toujours coupon).
id STRING $.id Identifiant interne unique du bon de réduction.
external_id STRING $.attributes.external_id Identifiant externe (souvent identique au nom/à l'ID).
description STRING $.attributes.description Description de l'offre de coupon.
low_balance_threshold STRING $.attributes.monitor_configuration.low_balance_threshold Seuil de déclenchement des alertes de solde faible.

CouponCode

Codes uniques individuels générés pour des bons de réduction spécifiques.

Nom du champ Type Chemin d'accès JSON Description
type STRING $.type Type de ressource (toujours coupon-code).
id STRING $.id Identifiant unique de cette instance de code spécifique.
unique_code STRING $.attributes.unique_code Chaîne de code alphanumérique réelle.
expires_at TIMESTAMP $.attributes.expires_at Code temporel correspondant à l'expiration de ce code.
status STRING $.attributes.status État du code (par exemple, ASSIGNED, UNASSIGNED).
coupon_id STRING $.relationships.coupon.data.id ID de la définition du bon de réduction parent.

Événements

Événements d'activité suivis pour les profils (par exemple, "Commande passée", "Produit consulté").

  • Nom de la table : Events
  • Point de terminaison : /events
  • Documentation de référence de l'API Klaviyo : Get Events
Nom du champ Type Chemin d'accès JSON Description
type STRING $.type Type de ressource (toujours event).
id STRING $.id Identifiant unique de l'événement.
timestamp FLOAT $.attributes.timestamp Code temporel Unix de l'événement.
event_properties JSON $.attributes.event_properties Propriétés JSON personnalisées spécifiques au type d'événement (par exemple, les articles d'une commande).
datetime TIMESTAMP $.attributes.datetime Code temporel ISO 8601 de l'événement.
uuid STRING $.attributes.uuid Identifiant unique universel de l'événement.
profile_id STRING $.relationships.profile.data.id ID du profil (client) associé à l'événement.
metric_id STRING $.relationships.metric.data.id ID de la définition de la métrique (type d'événement).
attribution_ids REPEATED STRING $.relationships.attributions.data[*].id ID des campagnes/flux attribués à cet événement.

Flux

Flux marketing automatisés déclenchés par des événements ou des conditions spécifiques.

  • Nom de la table : Flows
  • Point de terminaison : /flows
  • Documentation de référence de l'API Klaviyo : Get Flows
Nom du champ Type Chemin d'accès JSON Description
type STRING $.type Type de ressource (toujours flow).
id STRING $.id Identifiant unique du flux.
name STRING $.attributes.name Nom du flux.
status STRING $.attributes.status État opérationnel (par exemple, en ligne, brouillon).
archived BOOLÉEN $.attributes.archived Indique si le flux est archivé.
created TIMESTAMP $.attributes.created Code temporel de création.
updated TIMESTAMP $.attributes.updated Code temporel de la dernière modification.
trigger_type STRING $.attributes.trigger_type Mécanisme déclenchant le flux (par exemple, "Ajouté à la liste", "Métrique").
flow_actions_ids REPEATED STRING $.relationships.flow-actions.data[*].id ID des actions (étapes) de ce flux.
tag_ids REPEATED STRING $.relationships.tags.data[*].id ID des tags attribués à ce flux.

Forms

Formulaires d'inscription pour collecter des informations sur les abonnés.

  • Nom de la table : Forms
  • Point de terminaison : /forms
  • Documentation de référence de l'API Klaviyo : Get Forms
Nom du champ Type Chemin d'accès JSON Description
type STRING $.type Type de ressource (toujours form).
id STRING $.id Identifiant unique du formulaire.
name STRING $.attributes.name Nom du formulaire.
status STRING $.attributes.status État du formulaire (par exemple, en ligne, brouillon).
ab_test BOOLÉEN $.attributes.ab_test Indique si le formulaire exécute un test A/B.
created_at TIMESTAMP $.attributes.created_at Code temporel de création.
updated_at TIMESTAMP $.attributes.updated_at Code temporel de la dernière modification.

Images

Images importées dans Klaviyo pour être utilisées dans des campagnes et des modèles.

  • Nom de la table : Images
  • Point de terminaison : /images
  • Documentation de référence de l'API Klaviyo : Get Images
Nom du champ Type Chemin d'accès JSON Description
type STRING $.type Type de ressource (toujours image).
id STRING $.id Identifiant unique.
name STRING $.attributes.name Nom de fichier ou nom de l'image.
image_url STRING $.attributes.image_url URL publique permettant d'accéder à l'image.
format STRING $.attributes.format Format de fichier image (par exemple, jpeg, png).
size FLOAT $.attributes.size Taille du fichier en octets.
hidden BOOLÉEN $.attributes.hidden Indique si l'image est masquée dans l'interface utilisateur.
updated_at TIMESTAMP $.attributes.updated_at Code temporel de la dernière modification.

Listes

Listes statiques de contacts/profils.

  • Nom de la table : Lists
  • Point de terminaison : /lists
  • Documentation de référence de l'API Klaviyo : Get Lists
Nom du champ Type Chemin d'accès JSON Description
type STRING $.type Type de ressource (toujours list).
id STRING $.id Identifiant unique de la liste.
name STRING $.attributes.name Nom de la liste de contacts.
created TIMESTAMP $.attributes.created Code temporel de création.
updated TIMESTAMP $.attributes.updated Code temporel de la dernière modification.
opt_in_process STRING $.attributes.opt_in_process Paramètre d'activation (par exemple, "singleoptin" ou "doubleoptin").
tag_ids REPEATED STRING $.relationships.tags.data[*].id ID des tags attribués à cette liste.
flow_triggers_ids REPEATED STRING $.relationships.flow-triggers.data[*].id ID des flux déclenchés par l'ajout de profils à cette liste.

Métriques

Types d'événements pouvant être suivis (par exemple, "E-mail reçu").

  • Nom de la table : Metrics
  • Point de terminaison : /metrics
  • Documentation de référence de l'API Klaviyo : Get Metrics
Nom du champ Type Chemin d'accès JSON Description
type STRING $.type Type de ressource (toujours metric).
id STRING $.id Identifiant unique (par exemple, code à six caractères pour les types génériques, UUID long pour les types personnalisés).
name STRING $.attributes.name Nom lisible par l'humain (par exemple, "Commande passée").
created TIMESTAMP $.attributes.created Code temporel de création.
updated TIMESTAMP $.attributes.updated Code temporel de la dernière modification.
integration JSON $.attributes.integration Informations sur l'intégration fournissant cette métrique (par exemple, nom, catégorie, image).
flow_triggers_ids REPEATED STRING $.relationships.flow-triggers.data[*].id ID des flux déclenchés par cette métrique.

Profils

Profils de clients complets contenant des attributs et l'historique d'activité.

  • Nom de la table : Profiles
  • Point de terminaison : /profiles
  • Documentation de référence de l'API Klaviyo : Get Profiles
Nom du champ Type Chemin d'accès JSON Description
type STRING $.type Type de ressource (toujours profile).
id STRING $.id ID Klaviyo unique du profil.
email STRING $.attributes.email Adresse e-mail principale.
phone_number STRING $.attributes.phone_number Numéro de téléphone au format E.164.
external_id STRING $.attributes.external_id ID d'un système externe.
first_name STRING $.attributes.first_name Prénom
last_name STRING $.attributes.last_name Nom
organization STRING $.attributes.organization Nom de l'entreprise ou de l'organisation.
locale STRING $.attributes.locale Paramètre régional/linguistique.
title STRING $.attributes.title Intitulé du poste.
image STRING $.attributes.image URL de l'image de profil.
created TIMESTAMP $.attributes.created Code temporel de création du profil.
updated TIMESTAMP $.attributes.updated Horodatage de la dernière modification.
last_event_date TIMESTAMP $.attributes.last_event_date Code temporel de l'événement le plus récent.
address1 STRING $.attributes.location.address1 Ligne d'adresse 1.
address2 STRING $.attributes.location.address2 Ligne d'adresse 2.
city STRING $.attributes.location.city Ville.
country STRING $.attributes.location.country Pays.
latitude STRING $.attributes.location.latitude Coordonnées de latitude.
longitude STRING $.attributes.location.longitude Coordonnées de longitude.
region STRING $.attributes.location.region État ou région.
zip STRING $.attributes.location.zip Code postal.
timezone STRING $.attributes.location.timezone Fuseau horaire.
ip STRING $.attributes.location.ip avec une adresse IP externe.
properties JSON $.attributes.properties Paires clé-valeur des propriétés personnalisées.
email_marketing_can_receive_email_marketing BOOLÉEN $.attributes.subscriptions.email.marketing.can_receive_email_marketing Indique si le profil peut recevoir des e-mails marketing.
email_marketing_consent STRING $.attributes.subscriptions.email.marketing.consent État du consentement (par exemple, SUBSCRIBED, UNSUBSCRIBED).
email_marketing_consent_timestamp TIMESTAMP $.attributes.subscriptions.email.marketing.consent_timestamp Date à laquelle le consentement a été donné.
email_marketing_last_updated TIMESTAMP $.attributes.subscriptions.email.marketing.last_updated Date de la dernière mise à jour du consentement par e-mail.
email_marketing_method STRING $.attributes.subscriptions.email.marketing.method Méthode de consentement (par exemple, FORM).
email_marketing_method_detail STRING $.attributes.subscriptions.email.marketing.method_detail Source spécifique de la méthode.
email_marketing_custom_method_detail STRING $.attributes.subscriptions.email.marketing.custom_method_detail Informations personnalisées sur la méthode de consentement.
email_marketing_double_optin BOOLÉEN $.attributes.subscriptions.email.marketing.double_optin Indique si la double activation a été effectuée.
sms_marketing_can_receive_sms_marketing BOOLÉEN $.attributes.subscriptions.sms.marketing.can_receive_sms_marketing Indique si le profil peut recevoir des SMS marketing.
sms_marketing_consent STRING $.attributes.subscriptions.sms.marketing.consent État du consentement pour les SMS.
sms_marketing_consent_timestamp TIMESTAMP $.attributes.subscriptions.sms.marketing.consent_timestamp Date à laquelle l'autorisation d'envoyer des SMS a été accordée.
sms_marketing_last_updated TIMESTAMP $.attributes.subscriptions.sms.marketing.last_updated Date de la dernière mise à jour du consentement pour les SMS.
sms_marketing_method STRING $.attributes.subscriptions.sms.marketing.method Méthode de consentement par SMS.
sms_marketing_method_detail STRING $.attributes.subscriptions.sms.marketing.method_detail Informations sur la méthode de consentement par SMS.
sms_transactional_can_receive_sms_transactional BOOLÉEN $.attributes.subscriptions.sms.transactional.can_receive_sms_transactional Indique si le profil peut recevoir des SMS transactionnels.
sms_transactional_consent STRING $.attributes.subscriptions.sms.transactional.consent État du consentement pour les SMS transactionnels.
sms_transactional_consent_timestamp TIMESTAMP $.attributes.subscriptions.sms.transactional.consent_timestamp Date et heure auxquelles le consentement transactionnel a été donné.
sms_transactional_last_updated TIMESTAMP $.attributes.subscriptions.sms.transactional.last_updated Date de la dernière mise à jour de l'état transactionnel.
sms_transactional_method STRING $.attributes.subscriptions.sms.transactional.method Méthode SMS transactionnelle.
sms_transactional_method_detail STRING $.attributes.subscriptions.sms.transactional.method_detail Détails de la méthode SMS transactionnel.
mobile_push_can_receive_push_marketing BOOLÉEN $.attributes.subscriptions.mobile_push.marketing.can_receive_push_marketing Indique si le profil peut recevoir des notifications push marketing.
mobile_push_consent STRING $.attributes.subscriptions.mobile_push.marketing.consent Envoyez l'état du consentement.
mobile_push_consent_timestamp TIMESTAMP $.attributes.subscriptions.mobile_push.marketing.consent_timestamp Date et heure auxquelles l'autorisation d'envoi de notifications push a été accordée.
predictive_analytics_historic_number_of_orders FLOAT $.attributes.predictive_analytics.historic_number_of_orders Nombre total de commandes historiques.
predictive_analytics_predicted_number_of_orders FLOAT $.attributes.predictive_analytics.predicted_number_of_orders Commandes futures prévues.
predictive_analytics_average_days_between_orders FLOAT $.attributes.predictive_analytics.average_days_between_orders Nombre moyen de jours entre les commandes.
predictive_analytics_average_order_value FLOAT $.attributes.predictive_analytics.average_order_value Valeur moyenne historique de la commande.
predictive_analytics_historic_clv FLOAT $.attributes.predictive_analytics.historic_clv Valeur vie client historique.
predictive_analytics_predicted_clv FLOAT $.attributes.predictive_analytics.predicted_clv Valeur vie client prévue.
predictive_analytics_total_clv FLOAT $.attributes.predictive_analytics.total_clv Valeur vie client historique + prédite.
predictive_analytics_churn_probability FLOAT $.attributes.predictive_analytics.churn_probability Probabilité de perte de l'utilisateur (0-1).
predictive_analytics_expected_date_of_next_order TIMESTAMP $.attributes.predictive_analytics.expected_date_of_next_order Date prévue de la prochaine commande.
email_marketing_suppression_reason JSON RÉPÉTÉ $.attributes.subscriptions.email.marketing.suppression[*] Motifs de suppression des e-mails (par exemple, rejetés).
email_marketing_list_suppressions_reason JSON RÉPÉTÉ $.attributes.subscriptions.email.marketing.list_suppressions[*] Motifs de suppression spécifiques à la liste.
push_tokens_ids REPEATED STRING $.relationships.push-tokens.data[*].id ID de jeton push associés.

Avis

Avis sur les produits envoyés par les clients.

Nom du champ Type Chemin d'accès JSON Description
type STRING $.type Type de ressource (toujours review).
id STRING $.id Identifiant unique de l'avis.
email STRING $.attributes.email Adresse e-mail de l'examinateur.
value STRING $.attributes.status.value Valeur de l'état (par exemple, "publié", "refusé").
reason STRING $.attributes.status.rejection_reason.reason Motif du refus, le cas échéant.
status_explanation STRING $.attributes.status.rejection_reason.status_explanation Explication détaillée de l'état.
verified BOOLÉEN $.attributes.verified Indique si l'achat a été validé.
review_type STRING $.attributes.review_type Type d'avis (par exemple, avis sur un produit).
created TIMESTAMP $.attributes.created Code temporel de création.
updated TIMESTAMP $.attributes.updated Code temporel de la dernière modification.
images REPEATED STRING $.attributes.images[*] URL des images jointes à l'avis.
product_url STRING $.attributes.product.url URL du produit évalué.
product_name STRING $.attributes.product.name Nom du produit.
product_image_url STRING $.attributes.product.image_url URL de l'image du produit.
product_external_id STRING $.attributes.product.external_id ID externe du produit.
rating INTEGER $.attributes.rating Note.
author STRING $.attributes.author Nom de l'auteur de l'avis.
content STRING $.attributes.content Contenu textuel de l'avis.
title STRING $.attributes.title Titre de l'avis.
smart_quote STRING $.attributes.smart_quote Citation mise en avant de l'avis.
public_reply_content STRING $.attributes.public_reply.content Contenu de la réponse publique du marchand.
public_reply_author STRING $.attributes.public_reply.author Auteur de la réponse.
public_reply_updated STRING $.attributes.public_reply.updated Code temporel de la mise à jour de la réponse.
event_ids REPEATED STRING $.relationships.events.data[*].id ID des événements associés.

Segments

Groupes dynamiques de profils basés sur des critères spécifiques.

  • Nom de la table : Segments
  • Point de terminaison : /segments
  • Documentation de référence de l'API Klaviyo : Get Segments
Nom du champ Type Chemin d'accès JSON Description
type STRING $.type Type de ressource (toujours segment).
id STRING $.id Identifiant unique du segment.
name STRING $.attributes.name Nom du segment.
created TIMESTAMP $.attributes.created Code temporel de création.
updated TIMESTAMP $.attributes.updated Code temporel de la dernière modification.
is_active BOOLÉEN $.attributes.is_active Indique si le segment est actif.
is_processing BOOLÉEN $.attributes.is_processing Indique si le segment est en cours de traitement.
is_starred BOOLÉEN $.attributes.is_starred Indique si le segment est suivi/ajouté aux favoris.
tag_ids REPEATED STRING $.relationships.tags.data[*].id ID des tags associés.
flow_triggers_ids REPEATED STRING $.relationships.flow-triggers.data[*].id ID des flux déclenchés par ce segment.
condition_groups REPEATED ConditionGroup $.attributes.definition.condition_groups[*] Groupes de conditions logiques définissant le segment.

ConditionGroup

Nom du champ Type Chemin d'accès JSON Description
conditions Condition REPEATED conditions[*] Liste des conditions individuelles au sein du groupe.

Condition

Nom du champ Type Chemin d'accès JSON Description
type STRING type Type de condition (par exemple, profile-property).
value JSON N/A Valeur/configuration de la condition.

Tags

Tags utilisés pour organiser les campagnes, les flux et les listes.

  • Nom de la table : Tags
  • Point de terminaison : /tags
  • Documentation de référence de l'API Klaviyo : Get Tags
Nom du champ Type Chemin d'accès JSON Description
type STRING $.type Type de ressource (toujours tag).
id STRING $.id Identifiant unique du tag.
name STRING $.attributes.name Nom du tag.
tag_group_id STRING $.relationships.tag-group.data.id ID du groupe de tags auquel appartient ce tag.

Modèles

Modèles d'e-mails et de messages.

  • Nom de la table : Templates
  • Point de terminaison : /templates
  • Documentation de référence de l'API Klaviyo : Get Templates
Nom du champ Type Chemin d'accès JSON Description
type STRING $.type Type de ressource (toujours template).
id STRING $.id Identifiant unique.
name STRING $.attributes.name Nom du modèle.
editor_type STRING $.attributes.editor_type Éditeur utilisé (par exemple, glisser-déposer).
html STRING $.attributes.html Contenu HTML
text STRING $.attributes.text Version texte du modèle.
amp STRING $.attributes.amp Version AMP du modèle.
created TIMESTAMP $.attributes.created Code temporel de création.
updated TIMESTAMP $.attributes.updated Horodatage de la dernière modification.

WebFeeds

Flux Web utilisés pour insérer du contenu dans les messages.

  • Nom de la table : WebFeeds
  • Point de terminaison : /web-feeds
  • Documentation de référence de l'API Klaviyo : Get Web Feeds
Nom du champ Type Chemin d'accès JSON Description
type STRING $.type Type de ressource (toujours web-feed).
id STRING $.id Identifiant unique.
name STRING $.attributes.name Nom du flux.
url STRING $.attributes.url URL de la source du flux.
request_method STRING $.attributes.request_method Méthode HTTP (GET/POST).
content_type STRING $.attributes.content_type Type de contenu (par exemple, JSON).
status STRING $.attributes.status État du flux.
created TIMESTAMP $.attributes.created Code temporel de création.
updated TIMESTAMP $.attributes.updated Horodatage de la dernière modification.

DataSources

Sources de données intégrées à Klaviyo.

  • Nom de la table : DataSources
  • Point de terminaison : /data-sources
  • Documentation de référence de l'API Klaviyo : Get Data Sources
Nom du champ Type Chemin d'accès JSON Description
type STRING $.type Type de ressource (toujours data-source).
id STRING $.id Identifiant unique.
title STRING $.attributes.title Titre de la source de données.
visibility STRING $.attributes.visibility Niveau de visibilité.
description STRING $.attributes.description Texte de description.

Campagnes

Campagnes marketing envoyées à des listes ou à des segments.

  • Nom du tableau : Campagnes
  • Point de terminaison : /campaigns
  • Documentation de référence de l'API Klaviyo : Get Campaigns
Nom du champ Type Chemin d'accès JSON Description
type STRING $.type Type de ressource (toujours campaign).
id STRING $.id Identifiant unique.
name STRING $.attributes.name Nom de la campagne.
status STRING $.attributes.status État de la campagne (par exemple, "Envoyée", "Planification").
archived BOOLÉEN $.attributes.archived Indique si la campagne est archivée.
included REPEATED STRING $.attributes.audiences.included ID des listes/segments inclus.
excluded REPEATED STRING $.attributes.audiences.excluded ID des listes/segments exclus.
send_options JSON $.attributes.send_options Configuration de l'envoi (par exemple, envoi intelligent).
tracking_options JSON $.attributes.tracking_options Configuration pour le suivi (par exemple, paramètres UTM).
send_strategy JSON $.attributes.send_strategy Stratégie pour le délai de livraison.
created_at TIMESTAMP $.attributes.created_at Code temporel de création.
scheduled_at TIMESTAMP $.attributes.scheduled_at Date et heure auxquelles l'envoi de la campagne est planifié.
updated_at TIMESTAMP $.attributes.updated_at Horodatage de la dernière modification.
send_time TIMESTAMP $.attributes.send_time Heure d'envoi réelle.
tag_ids REPEATED STRING $.relationships.tags.data[*].id ID des tags associés.
campaign_message_ids REPEATED STRING $.relationships.campaign-messages.data[*].id ID des messages contenus dans cette campagne.

CampaignMessages

Messages individuels (e-mail/SMS) d'une campagne.

  • Nom de la table : CampaignMessages
  • Point de terminaison : /campaign-messages
  • Documentation de référence de l'API Klaviyo : Get Campaign Message
Nom du champ Type Chemin d'accès JSON Description
type STRING $.type Type de ressource (toujours campaign-message).
id STRING $.id Identifiant unique.
definition JSON $.attributes.definition Contenu et configuration du message.
send_times JSON RÉPÉTÉ $.attributes.send_times[*] Heures d'envoi programmées.
created_at TIMESTAMP $.attributes.created_at Code temporel de création.
updated_at TIMESTAMP $.attributes.updated_at Horodatage de la dernière modification.
campaign_id STRING $.relationships.campaign.data.id ID de la campagne parente.
template_id STRING $.relationships.template.data.id ID du modèle utilisé.
image_id STRING $.relationships.image.data.id ID de l'image jointe.

Catégories

Catégories de produits de votre catalogue.

  • Nom de la table : Categories
  • Point de terminaison : /catalog-categories
  • Documentation de référence de l'API Klaviyo : Get Catalog Categories
Nom du champ Type Chemin d'accès JSON Description
type STRING $.type Type de ressource.
id STRING $.id Identifiant unique.
name STRING $.attributes.name Nom de la catégorie.
external_id STRING $.attributes.external_id ID du système externe.
updated TIMESTAMP $.attributes.updated Horodatage de la dernière modification.

Éléments

Produits ou articles individuels de votre catalogue.

  • Nom de la table : Items
  • Point de terminaison : /catalog-items
  • Documentation de référence de l'API Klaviyo : Get Catalog Items
Nom du champ Type Chemin d'accès JSON Description
type STRING $.type Type de ressource.
id STRING $.id Identifiant unique.
external_id STRING $.attributes.external_id ID du système externe.
title STRING $.attributes.title Titre/nom de l'élément.
description STRING $.attributes.description Description disponible.
price FLOAT $.attributes.price Prix de l'article
url STRING $.attributes.url URL de l'élément.
image_full_url STRING $.attributes.image_full_url URL de l'image en taille réelle.
image_thumbnail_url STRING $.attributes.image_thumbnail_url URL de la vignette.
images REPEATED STRING $.attributes.images[*] Liste des URL d'images supplémentaires.
custom_metadata JSON $.attributes.custom_metadata Clés-valeurs de métadonnées personnalisées.
published BOOLÉEN $.attributes.published État de la publication.
created TIMESTAMP $.attributes.created Code temporel de création.
updated TIMESTAMP $.attributes.updated Horodatage de la dernière modification.
variants_ids REPEATED STRING $.relationships.variants.data[*].id ID des variantes de cet article.

Variantes

Variantes spécifiques d'articles du catalogue (par exemple, tailles, couleurs).

  • Nom de la table : Variants
  • Point de terminaison : /catalog-variants
  • Documentation de référence de l'API Klaviyo : Get Catalog Variants
Nom du champ Type Chemin d'accès JSON Description
type STRING $.type Type de ressource.
id STRING $.id Identifiant unique.
external_id STRING $.attributes.external_id ID du système externe.
title STRING $.attributes.title Titre de la variante.
description STRING $.attributes.description Description disponible.
sku STRING $.attributes.sku Unité de gestion des stocks.
inventory_policy FLOAT $.attributes.inventory_policy Règle de gestion de l'inventaire.
inventory_quantity FLOAT $.attributes.inventory_quantity Quantité actuelle en stock.
price FLOAT $.attributes.price Prix.
url STRING $.attributes.url URL de la variante.
image_full_url STRING $.attributes.image_full_url URL de l'image complète disponible (booléen).
image_thumbnail_url STRING $.attributes.image_thumbnail_url URL de la vignette.
images REPEATED STRING $.attributes.images[*] Liste d'images.
published BOOLÉEN $.attributes.published État de la publication.
created TIMESTAMP $.attributes.created Code temporel de création.
updated TIMESTAMP $.attributes.updated Horodatage de la dernière modification.

FlowActions

Actions de flux associées à un flux.

  • Nom de la table : FlowActions
  • Point de terminaison : /flows/{id}/flow-actions
  • Documentation de référence de l'API Klaviyo : Get Flow Actions
Nom du champ Type Chemin d'accès JSON Description
type STRING $.type Type de ressource. Toujours flow-action.
id STRING $.id Identifiant unique de l'action de flux.
created TIMESTAMP $.attributes.created Code temporel de création.
updated TIMESTAMP $.attributes.updated Code temporel de la dernière modification.
message_id STRING $.attributes.definition.id Identifiant unique de la définition du message d'action.
message_temporary_id STRING $.attributes.definition.temporary_id ID temporaire attribué à la définition du message.
message_type STRING $.attributes.definition.type Type de message, par exemple email, sms.
condition_groups REPEATED ConditionGroup $.attributes.definition.data.action_output_filter.condition_groups[*] Conditions associées au filtre de sortie de l'action de flux.
next_if_true STRING $.attributes.definition.links.next_if_true ID de l'action de flux suivante si la condition est évaluée à true.
next_if_false STRING $.attributes.definition.links.next_if_false ID de l'action de flux suivante si la condition est évaluée à false.

FormVersions

Versions d'un formulaire donné.

  • Nom de la table : FormVersions
  • Point de terminaison : /forms/{id}/form-versions
  • Documentation de référence de l'API Klaviyo : Get Form Versions
Nom du champ Type Chemin d'accès JSON Description
type STRING $.type Type de ressource. Toujours form-version.
id STRING $.id Identifiant unique de la version du formulaire.
form_type STRING $.attributes.form_type Type de formulaire, par exemple popup, embed, banner.
variation_name STRING $.attributes.variation_name Nom de la variante du formulaire.
ab_test JSON $.attributes.ab_test Paramètres de configuration et de variation des tests A/B.
status STRING $.attributes.status État opérationnel de la version du formulaire, par exemple draft, live.
created_at TIMESTAMP $.attributes.created_at Code temporel de création.
updated_at TIMESTAMP $.attributes.updated_at Code temporel de la dernière modification.

PushTokens

Jetons push associés aux profils d'applications mobiles pour les notifications push.

  • Nom de la table : PushTokens
  • Point de terminaison : /push-tokens
  • Documentation de référence de l'API Klaviyo : Get Push Tokens
Nom du champ Type Chemin d'accès JSON Description
type STRING $.type Type de ressource. Toujours push-token.
id STRING $.id Identifiant unique du jeton push.
created TIMESTAMP $.attributes.created Code temporel de création.
token STRING $.attributes.token Chaîne du jeton push de l'appareil.
enablement_status STRING $.attributes.enablement_status État d'activation des notifications push, par exemple AUTHORIZED, UNAUTHORIZED.
platform STRING $.attributes.platform Plate-forme mobile, telle que ios, android.
vendor STRING $.attributes.vendor Fournisseur de services, tel que apns ou fcm.
background STRING $.attributes.background État de l'actualisation en arrière-plan pour les notifications push.
recorded_date TIMESTAMP $.attributes.recorded_date Date à laquelle le jeton push a été enregistré.
metadata JSON $.attributes.metadata Métadonnées d'appareil ou de jeton push personnalisées.
profile_id STRING $.relationships.profile.data.id ID du profil client associé à ce jeton push.

TagGroups

Les groupes de tags permettent d'organiser et de classer les tags.

  • Nom de la table : TagGroups
  • Point de terminaison : /tag-groups
  • Documentation de référence de l'API Klaviyo : Get Tag Groups
Nom du champ Type Chemin d'accès JSON Description
type STRING $.type Type de ressource. Toujours tag-group.
id STRING $.id Identifiant unique du groupe de tags.
name STRING $.attributes.name Nom du groupe de tags.
exclusive BOOLÉEN $.attributes.exclusive Indique si les tags de ce groupe s'excluent mutuellement.
default BOOLÉEN $.attributes.default Indique s'il s'agit du groupe de balises par défaut du compte.

UniversalContent

Blocs de contenu universels réutilisables pour les messages et les modèles.

  • Nom de la table : UniversalContent
  • Point de terminaison : /template-universal-content
  • Documentation de référence de l'API Klaviyo : Get Universal Content
Nom du champ Type Chemin d'accès JSON Description
type STRING $.type Type de ressource. Toujours template-universal-content.
id STRING $.id Identifiant unique du bloc de contenu universel.
name STRING $.attributes.name Nom du bloc de contenu universel.
definition_content_type STRING $.attributes.definition.content_type Type de contenu de la définition, tel que block, template.
definition_type STRING $.attributes.definition.type Type de composant du contenu, tel que text, button, image.
definition_data JSON $.attributes.definition.data Données structurelles et charge utile de la définition du contenu.
created TIMESTAMP $.attributes.created Code temporel de création.
updated TIMESTAMP $.attributes.updated Code temporel de la dernière modification.
screenshot_status STRING $.attributes.screenshot_status État de la génération de la capture d'écran d'aperçu, par exemple completed, pending.
screenshot_url STRING $.attributes.screenshot_url URL publique de la capture d'écran de l'aperçu du contenu.

MetricProperties

Propriétés et attributs structurels définis pour des métriques spécifiques.

  • Nom de la table : MetricProperties
  • Point de terminaison : /metrics/{id}/metric-properties
  • Documentation de référence de l'API Klaviyo : Get Metric Properties
Nom du champ Type Chemin d'accès JSON Description
type STRING $.type Type de ressource. Toujours metric-property.
id STRING $.id Identifiant unique de la propriété de la métrique.
sample_values JSON $.attributes.sample_values Exemples de valeurs de données capturées pour cette propriété de métrique.
label STRING $.attributes.label Libellé lisible par l'humain pour la propriété.
property STRING $.attributes.property Nom de la clé de la propriété d'événement.
inferred_type STRING $.attributes.inferred_type Type de données déduit par Klaviyo pour cette propriété, par exemple string, boolean, numeric.
metric_id STRING $.relationships.metric.data.id ID de la définition de métrique parente.

TrackingSettings

Paramètres de suivi UTM au niveau du compte pour les campagnes et les flux.

  • Nom de la table : TrackingSettings
  • Point de terminaison : /tracking-settings
  • Documentation de référence de l'API Klaviyo : Get Tracking Settings
Nom du champ Type Chemin d'accès JSON Description
type STRING $.type Type de ressource. Toujours tracking-setting.
id STRING $.id Identifiant unique des paramètres de suivi.
auto_add_parameters BOOLÉEN $.attributes.auto_add_parameters Indique si les paramètres UTM sont automatiquement ajoutés aux liens des messages.
utm_source UtmParameter $.attributes.utm_source Configuration de _utm_source parameter dans les flux et les campagnes.
utm_medium UtmParameter $.attributes.utm_medium Configuration de _utm_medium parameter dans les flux et les campagnes.
utm_campaign UtmParameter $.attributes.utm_campaign Configuration du paramètre _utm_campaign dans les flux et les campagnes.
utm_id UtmParameter $.attributes.utm_id Configuration du paramètre _utm_id dans les flux et les campagnes.
utm_term UtmParameter $.attributes.utm_term Configuration du paramètre _utm_term dans les flux et les campagnes.
custom_parameters REPEATED CustomParameter $.attributes.custom_parameters Paramètres de suivi personnalisés ajoutés aux liens de campagne et de flux.

UtmParameter

Nom du champ Type Chemin d'accès JSON Description
flow ParameterContext flow Contexte des paramètres UTM pour les flux.
campaign ParameterContext campaign Contexte des paramètres UTM pour les campagnes.

ParameterContext

Nom du champ Type Chemin d'accès JSON Description
type STRING type Type de ressource.
value STRING value Valeur du modèle de paramètre ou clé d'attribut, telle que emailsubject, campaignid.

CustomParameter

Nom du champ Type Chemin d'accès JSON Description
flow ParameterContext flow Contexte du paramètre de suivi personnalisé pour les flux.
campaign ParameterContext campaign Contexte du paramètre de suivi personnalisé pour les campagnes.
name STRING name Nom du paramètre de suivi personnalisé.