Referencia del modelo de datos de Klaviyo

En esta página, se enumeran los datos que se transfieren a BigQuery cuando ejecutas una transferencia de datos de Klaviyo. Los datos se organizan en tablas que enumeran cada nombre de campo, su tipo de datos de destino asociado y la ruta de acceso JSON de los datos de origen.

Cuentas

Información y metadatos de la cuenta de Klaviyo

  • Nombre de la tabla: Accounts
  • Extremo: /accounts
  • Referencia de la API de Klaviyo: Get Accounts
Nombre del campo Tipo Ruta de JSON Descripción
type STRING $.type Es el tipo de recurso (siempre account).
id STRING $.id Es el identificador único de la cuenta.
test_account STRING $.attributes.test_account Indica si se trata de una cuenta de prueba.
default_sender_name STRING $.attributes.contact_information.default_sender_name Es el nombre predeterminado que se usa como remitente de los correos electrónicos.
default_sender_email STRING $.attributes.contact_information.default_sender_email Es la dirección de correo electrónico predeterminada que se usa como remitente.
website_url STRING $.attributes.contact_information.website_url Es la URL del sitio web de la organización.
organization_name STRING $.attributes.contact_information.organization_name Nombre de la organización.
address1 STRING $.attributes.contact_information.street_address.address1 Línea de dirección 1.
address2 STRING $.attributes.contact_information.street_address.address2 Línea de dirección 2.
city STRING $.attributes.contact_information.street_address.city Es la ciudad de la organización.
region STRING $.attributes.contact_information.street_address.region Estado, provincia o región.
country STRING $.attributes.contact_information.street_address.country País.
zip STRING $.attributes.contact_information.street_address.zip Código postal
industry STRING $.attributes.industry Es la vertical de la industria de la cuenta.
timezone STRING $.attributes.timezone Es el parámetro de configuración de la zona horaria de la cuenta.
preferred_currency STRING $.attributes.preferred_currency Es la moneda principal que usa la cuenta.
public_api_key STRING $.attributes.public_api_key Clave de API pública (ID del sitio) para integraciones del cliente.
locale STRING $.attributes.locale Es el parámetro de configuración regional (p.ej., en-US).

Cupones

Cupones para descuentos y promociones

  • Nombre de la tabla: Cupones
  • Extremo: /coupons
  • Referencia de la API de Klaviyo: Get Coupons
Nombre del campo Tipo Ruta de JSON Descripción
type STRING $.type Tipo de recurso (siempre coupon).
id STRING $.id Es el identificador interno único del cupón.
external_id STRING $.attributes.external_id Identificador externo (suele ser el mismo que el nombre o el ID)
description STRING $.attributes.description Es la descripción de la oferta del cupón.
low_balance_threshold STRING $.attributes.monitor_configuration.low_balance_threshold Es el umbral para activar las alertas de saldo bajo.

CouponCode

Son códigos únicos individuales que se generan para cupones específicos.

Nombre del campo Tipo Ruta de JSON Descripción
type STRING $.type Tipo de recurso (siempre coupon-code).
id STRING $.id Es el identificador único de esta instancia de código específica.
unique_code STRING $.attributes.unique_code Es la cadena de código alfanumérico real.
expires_at TIMESTAMP $.attributes.expires_at Marca de tiempo en la que vence este código.
status STRING $.attributes.status Es el estado del código (p.ej., ASSIGNED, UNASSIGNED).
coupon_id STRING $.relationships.coupon.data.id ID de la definición del cupón superior.

Eventos

Eventos de actividad de los que se hace un seguimiento para los perfiles (p.ej., Pedido realizado, Producto visto).

  • Nombre de la tabla: Events
  • Extremo: /events
  • Referencia de la API de Klaviyo: Get Events
Nombre del campo Tipo Ruta de JSON Descripción
type STRING $.type Tipo de recurso (siempre event).
id STRING $.id Identificador único para el evento.
timestamp FLOAT $.attributes.timestamp Es la marca de tiempo de Unix del momento en que ocurrió el evento.
event_properties JSON $.attributes.event_properties Son propiedades JSON personalizadas específicas del tipo de evento (p.ej., artículos en el pedido).
datetime TIMESTAMP $.attributes.datetime Es la marca de tiempo ISO 8601 del evento.
uuid STRING $.attributes.uuid Es el identificador único universal del evento.
profile_id STRING $.relationships.profile.data.id Es el ID del perfil (cliente) asociado con el evento.
metric_id STRING $.relationships.metric.data.id Es el ID de la definición de la métrica (tipo de evento).
attribution_ids REPEATED STRING $.relationships.attributions.data[*].id Son los IDs de las campañas o los flujos atribuidos a este evento.

Flujos

Son flujos de marketing automatizados que se activan con eventos o condiciones específicos.

  • Nombre de la tabla: Flujos
  • Extremo: /flows
  • Referencia de la API de Klaviyo: Get Flows
Nombre del campo Tipo Ruta de JSON Descripción
type STRING $.type Tipo de recurso (siempre flow).
id STRING $.id Es el identificador único del flujo.
name STRING $.attributes.name Es el nombre del flujo.
status STRING $.attributes.status Estado operativo (p. ej., publicado, borrador)
archived BOOLEAN $.attributes.archived Indica si el flujo está archivado.
created TIMESTAMP $.attributes.created Marca de tiempo de creación
updated TIMESTAMP $.attributes.updated Marca de tiempo de la última modificación.
trigger_type STRING $.attributes.trigger_type Es el mecanismo que activa el flujo (p.ej., "Agregado a la lista", "Métrica").
flow_actions_ids REPEATED STRING $.relationships.flow-actions.data[*].id Son los IDs de las acciones (pasos) dentro de este flujo.
tag_ids REPEATED STRING $.relationships.tags.data[*].id Son los IDs de las etiquetas asignadas a este flujo.

Formularios

Formularios de registro para recopilar información de los suscriptores

  • Nombre de la tabla: Formularios
  • Extremo: /forms
  • Referencia de la API de Klaviyo: Get Forms
Nombre del campo Tipo Ruta de JSON Descripción
type STRING $.type Tipo de recurso (siempre form).
id STRING $.id Es el identificador único del formulario.
name STRING $.attributes.name Es el nombre del formulario.
status STRING $.attributes.status Estado del formulario (p. ej., publicado, borrador)
ab_test BOOLEAN $.attributes.ab_test Indica si el formulario está ejecutando una prueba A/B.
created_at TIMESTAMP $.attributes.created_at Marca de tiempo de creación
updated_at TIMESTAMP $.attributes.updated_at Marca de tiempo de la última modificación.

Imágenes

Imágenes subidas a Klaviyo para usarlas en campañas y plantillas

  • Nombre de la tabla: Images
  • Extremo: /images
  • Referencia de la API de Klaviyo: Get Images
Nombre del campo Tipo Ruta de JSON Descripción
type STRING $.type Tipo de recurso (siempre image).
id STRING $.id Es el identificador único.
name STRING $.attributes.name Nombre del archivo o de la imagen.
image_url STRING $.attributes.image_url Es la URL pública para acceder a la imagen.
format STRING $.attributes.format Es el formato del archivo de imagen (p.ej., jpeg o png).
size FLOAT $.attributes.size Es el tamaño del archivo en bytes.
hidden BOOLEAN $.attributes.hidden Indica si la imagen está oculta en la IU.
updated_at TIMESTAMP $.attributes.updated_at Marca de tiempo de la última modificación.

Listas

Listas estáticas de contactos o perfiles

  • Nombre de la tabla: Lists
  • Extremo: /lists
  • Referencia de la API de Klaviyo: Get Lists
Nombre del campo Tipo Ruta de JSON Descripción
type STRING $.type Es el tipo de recurso (siempre list).
id STRING $.id Es el identificador único de la lista.
name STRING $.attributes.name Es el nombre de la lista de contactos.
created TIMESTAMP $.attributes.created Marca de tiempo de creación
updated TIMESTAMP $.attributes.updated Marca de tiempo de la última modificación.
opt_in_process STRING $.attributes.opt_in_process Es el parámetro de configuración de habilitación (p.ej., "singleoptin" o "doubleoptin").
tag_ids REPEATED STRING $.relationships.tags.data[*].id Son los IDs de las etiquetas asignadas a esta lista.
flow_triggers_ids REPEATED STRING $.relationships.flow-triggers.data[*].id Son los IDs de los flujos que se activan cuando se agregan perfiles a esta lista.

Métricas

Son los tipos de eventos de los que se puede hacer un seguimiento (p.ej., "Correo electrónico recibido").

  • Nombre de la tabla: Métricas
  • Extremo: /metrics
  • Referencia de la API de Klaviyo: Get Metrics
Nombre del campo Tipo Ruta de JSON Descripción
type STRING $.type Tipo de recurso (siempre metric).
id STRING $.id Es el identificador único (p.ej., un código de 6 caracteres para el genérico o un UUID largo para el personalizado).
name STRING $.attributes.name Nombre legible por humanos (p.ej., "Pedido realizado").
created TIMESTAMP $.attributes.created Marca de tiempo de creación
updated TIMESTAMP $.attributes.updated Marca de tiempo de la última modificación.
integration JSON $.attributes.integration Información sobre la integración que proporciona esta métrica (p.ej., nombre, categoría, imagen).
flow_triggers_ids REPEATED STRING $.relationships.flow-triggers.data[*].id Son los IDs de los flujos que activa esta métrica.

Perfiles

Perfiles integrales de clientes que contienen atributos y el historial de actividad

  • Nombre de la tabla: Profiles
  • Extremo: /profiles
  • Referencia de la API de Klaviyo: Get Profiles
Nombre del campo Tipo Ruta de JSON Descripción
type STRING $.type Es el tipo de recurso (siempre profile).
id STRING $.id Es el ID único de Klaviyo para el perfil.
email STRING $.attributes.email Dirección de correo electrónico principal
phone_number STRING $.attributes.phone_number Número de teléfono en formato E.164.
external_id STRING $.attributes.external_id Es el ID de un sistema externo.
first_name STRING $.attributes.first_name Nombre.
last_name STRING $.attributes.last_name Apellido.
organization STRING $.attributes.organization Nombre de la empresa o de la organización.
locale STRING $.attributes.locale Configuración regional o de idioma
title STRING $.attributes.title Cargo
image STRING $.attributes.image Es la URL de la imagen de perfil.
created TIMESTAMP $.attributes.created Es la marca de tiempo de creación del perfil.
updated TIMESTAMP $.attributes.updated Es la marca de tiempo de la última actualización.
last_event_date TIMESTAMP $.attributes.last_event_date Es la marca de tiempo del evento más reciente.
address1 STRING $.attributes.location.address1 Línea de dirección 1.
address2 STRING $.attributes.location.address2 Línea de dirección 2.
city STRING $.attributes.location.city Ciudad.
country STRING $.attributes.location.country País.
latitude STRING $.attributes.location.latitude Coordenadas de latitud.
longitude STRING $.attributes.location.longitude Coordenadas de longitud.
region STRING $.attributes.location.region Estado o región
zip STRING $.attributes.location.zip Código postal
timezone STRING $.attributes.location.timezone Zona horaria.
ip STRING $.attributes.location.ip una dirección IP externa.
properties JSON $.attributes.properties Pares clave-valor de propiedades personalizadas.
email_marketing_can_receive_email_marketing BOOLEAN $.attributes.subscriptions.email.marketing.can_receive_email_marketing Indica si el perfil puede recibir marketing por correo electrónico.
email_marketing_consent STRING $.attributes.subscriptions.email.marketing.consent Estado del consentimiento (p. ej., SUBSCRIBED, UNSUBSCRIBED)
email_marketing_consent_timestamp TIMESTAMP $.attributes.subscriptions.email.marketing.consent_timestamp Cuándo se otorgó el consentimiento.
email_marketing_last_updated TIMESTAMP $.attributes.subscriptions.email.marketing.last_updated Indica cuándo se actualizó por última vez el consentimiento por correo electrónico.
email_marketing_method STRING $.attributes.subscriptions.email.marketing.method Es el método de consentimiento (p.ej., FORM).
email_marketing_method_detail STRING $.attributes.subscriptions.email.marketing.method_detail Fuente específica del método.
email_marketing_custom_method_detail STRING $.attributes.subscriptions.email.marketing.custom_method_detail Son los detalles personalizados del método de consentimiento.
email_marketing_double_optin BOOLEAN $.attributes.subscriptions.email.marketing.double_optin Indica si se completó la doble verificación.
sms_marketing_can_receive_sms_marketing BOOLEAN $.attributes.subscriptions.sms.marketing.can_receive_sms_marketing Indica si el perfil puede recibir marketing por SMS.
sms_marketing_consent STRING $.attributes.subscriptions.sms.marketing.consent Es el estado de consentimiento de SMS.
sms_marketing_consent_timestamp TIMESTAMP $.attributes.subscriptions.sms.marketing.consent_timestamp Cuándo se otorgó el consentimiento para recibir SMS.
sms_marketing_last_updated TIMESTAMP $.attributes.subscriptions.sms.marketing.last_updated Cuándo se actualizó por última vez el consentimiento para recibir SMS.
sms_marketing_method STRING $.attributes.subscriptions.sms.marketing.method Es el método de consentimiento para SMS.
sms_marketing_method_detail STRING $.attributes.subscriptions.sms.marketing.method_detail Son los detalles del método de consentimiento por SMS.
sms_transactional_can_receive_sms_transactional BOOLEAN $.attributes.subscriptions.sms.transactional.can_receive_sms_transactional Indica si el perfil puede recibir SMS transaccionales.
sms_transactional_consent STRING $.attributes.subscriptions.sms.transactional.consent Es el estado de consentimiento de SMS transaccionales.
sms_transactional_consent_timestamp TIMESTAMP $.attributes.subscriptions.sms.transactional.consent_timestamp Cuándo se otorgó el consentimiento transaccional.
sms_transactional_last_updated TIMESTAMP $.attributes.subscriptions.sms.transactional.last_updated Cuándo se actualizó por última vez el estado transaccional.
sms_transactional_method STRING $.attributes.subscriptions.sms.transactional.method Método de SMS transaccional.
sms_transactional_method_detail STRING $.attributes.subscriptions.sms.transactional.method_detail Detalles del método de SMS transaccionales.
mobile_push_can_receive_push_marketing BOOLEAN $.attributes.subscriptions.mobile_push.marketing.can_receive_push_marketing Indica si el perfil puede recibir marketing push.
mobile_push_consent STRING $.attributes.subscriptions.mobile_push.marketing.consent Estado del consentimiento de las notificaciones push.
mobile_push_consent_timestamp TIMESTAMP $.attributes.subscriptions.mobile_push.marketing.consent_timestamp Cuándo se otorgó el consentimiento para las notificaciones push.
predictive_analytics_historic_number_of_orders FLOAT $.attributes.predictive_analytics.historic_number_of_orders Es la cantidad total de pedidos históricos.
predictive_analytics_predicted_number_of_orders FLOAT $.attributes.predictive_analytics.predicted_number_of_orders Pedidos futuros previstos
predictive_analytics_average_days_between_orders FLOAT $.attributes.predictive_analytics.average_days_between_orders Promedio de días entre pedidos.
predictive_analytics_average_order_value FLOAT $.attributes.predictive_analytics.average_order_value Es el valor promedio histórico de los pedidos.
predictive_analytics_historic_clv FLOAT $.attributes.predictive_analytics.historic_clv Valor histórico del ciclo de vida del cliente.
predictive_analytics_predicted_clv FLOAT $.attributes.predictive_analytics.predicted_clv Valor previsto del ciclo de vida del cliente
predictive_analytics_total_clv FLOAT $.attributes.predictive_analytics.total_clv CLV histórico y previsto
predictive_analytics_churn_probability FLOAT $.attributes.predictive_analytics.churn_probability Es la probabilidad de deserción (0-1).
predictive_analytics_expected_date_of_next_order TIMESTAMP $.attributes.predictive_analytics.expected_date_of_next_order Es la fecha prevista del próximo pedido.
email_marketing_suppression_reason JSON REPEATED $.attributes.subscriptions.email.marketing.suppression[*] Son los motivos por los que se suprimió el correo electrónico (p.ej., rebotó).
email_marketing_list_suppressions_reason JSON REPEATED $.attributes.subscriptions.email.marketing.list_suppressions[*] Son los motivos de supresión específicos de la lista.
push_tokens_ids REPEATED STRING $.relationships.push-tokens.data[*].id Son los IDs de tokens push asociados.

Opiniones

Son las opiniones sobre productos que envían los clientes.

  • Nombre de la tabla: Reviews
  • Extremo: /reviews
  • Referencia de la API de Klaviyo: Get Reviews
Nombre del campo Tipo Ruta de JSON Descripción
type STRING $.type Tipo de recurso (siempre review).
id STRING $.id Es el identificador único de la opinión.
email STRING $.attributes.email Es el correo electrónico del revisor.
value STRING $.attributes.status.value Es el valor del estado (p.ej., publicado, rechazado).
reason STRING $.attributes.status.rejection_reason.reason Motivo del rechazo, si corresponde
status_explanation STRING $.attributes.status.rejection_reason.status_explanation Explicación detallada del estado.
verified BOOLEAN $.attributes.verified Indica si se verificó la compra.
review_type STRING $.attributes.review_type Tipo de opinión (p. ej., opinión sobre un producto)
created TIMESTAMP $.attributes.created Marca de tiempo de creación
updated TIMESTAMP $.attributes.updated Marca de tiempo de la última modificación.
images REPEATED STRING $.attributes.images[*] Son las URLs de las imágenes adjuntas a la opinión.
product_url STRING $.attributes.product.url Es la URL del producto sobre el que se opina.
product_name STRING $.attributes.product.name Es el nombre del producto.
product_image_url STRING $.attributes.product.image_url Es la URL de la imagen del producto.
product_external_id STRING $.attributes.product.external_id Es el ID externo del producto.
rating INTEGER $.attributes.rating Puntuación de la calificación.
author STRING $.attributes.author Es el nombre del usuario que deja la opinión.
content STRING $.attributes.content Es el contenido de texto de la opinión.
title STRING $.attributes.title Es el título de la opinión.
smart_quote STRING $.attributes.smart_quote Es una cita destacada de la opinión.
public_reply_content STRING $.attributes.public_reply.content Es el contenido de la respuesta pública del comercio.
public_reply_author STRING $.attributes.public_reply.author Es el autor de la respuesta.
public_reply_updated STRING $.attributes.public_reply.updated Es la marca de tiempo de la actualización de la respuesta.
event_ids REPEATED STRING $.relationships.events.data[*].id Son los IDs de eventos asociados.

Segmentos

Son grupos dinámicos de perfiles basados en criterios específicos.

  • Nombre de la tabla: Segments
  • Extremo: /segments
  • Referencia de la API de Klaviyo: Get Segments
Nombre del campo Tipo Ruta de JSON Descripción
type STRING $.type Tipo de recurso (siempre segment).
id STRING $.id Es el identificador único del segmento.
name STRING $.attributes.name Es el nombre del segmento.
created TIMESTAMP $.attributes.created Marca de tiempo de creación
updated TIMESTAMP $.attributes.updated Marca de tiempo de la última modificación.
is_active BOOLEAN $.attributes.is_active Indica si el segmento está activo.
is_processing BOOLEAN $.attributes.is_processing Indica si se está procesando el segmento.
is_starred BOOLEAN $.attributes.is_starred Indica si el segmento está marcado como favorito.
tag_ids REPEATED STRING $.relationships.tags.data[*].id Son los IDs de las etiquetas asociadas.
flow_triggers_ids REPEATED STRING $.relationships.flow-triggers.data[*].id Son los IDs de los flujos que activa este segmento.
condition_groups REPEATED ConditionGroup $.attributes.definition.condition_groups[*] Son grupos de condiciones lógicas que definen el segmento.

ConditionGroup

Nombre del campo Tipo Ruta de JSON Descripción
conditions Condición REPEATED conditions[*] Es la lista de condiciones individuales dentro del grupo.

Condición

Nombre del campo Tipo Ruta de JSON Descripción
type STRING type Tipo de condición (p.ej., profile-property).
value JSON N/A Valor o configuración de la condición

Etiquetas

Son etiquetas que se usan para organizar campañas, flujos y listas.

  • Nombre de la tabla: Tags
  • Extremo: /tags
  • Referencia de la API de Klaviyo: Get Tags
Nombre del campo Tipo Ruta de JSON Descripción
type STRING $.type Tipo de recurso (siempre tag).
id STRING $.id Es el identificador único de la etiqueta.
name STRING $.attributes.name Es el nombre de la etiqueta.
tag_group_id STRING $.relationships.tag-group.data.id Es el ID del grupo de etiquetas al que pertenece esta etiqueta.

Plantillas

Plantillas de correo electrónico y mensajes

  • Nombre de la tabla: Plantillas
  • Extremo: /templates
  • Referencia de la API de Klaviyo: Get Templates
Nombre del campo Tipo Ruta de JSON Descripción
type STRING $.type Tipo de recurso (siempre template).
id STRING $.id Es el identificador único.
name STRING $.attributes.name Es el nombre de la plantilla.
editor_type STRING $.attributes.editor_type Editor utilizado (p. ej., arrastrar y soltar)
html STRING $.attributes.html Contenido HTML
text STRING $.attributes.text Es la versión de texto de la plantilla.
amp STRING $.attributes.amp Es la versión de AMP de la plantilla.
created TIMESTAMP $.attributes.created Marca de tiempo de creación
updated TIMESTAMP $.attributes.updated Es la marca de tiempo de la última actualización.

WebFeeds

Son los feeds web que se usan para propagar contenido en los mensajes.

  • Nombre de la tabla: WebFeeds
  • Extremo: /web-feeds
  • Referencia de la API de Klaviyo: Get Web Feeds
Nombre del campo Tipo Ruta de JSON Descripción
type STRING $.type Tipo de recurso (siempre web-feed).
id STRING $.id Es el identificador único.
name STRING $.attributes.name Es el nombre del feed.
url STRING $.attributes.url Es la URL de la fuente del feed.
request_method STRING $.attributes.request_method Método HTTP (GET/POST)
content_type STRING $.attributes.content_type Tipo de contenido (p. ej., JSON)
status STRING $.attributes.status Es el estado del feed.
created TIMESTAMP $.attributes.created Marca de tiempo de creación
updated TIMESTAMP $.attributes.updated Es la marca de tiempo de la última actualización.

DataSources

Son las fuentes de datos integradas en Klaviyo.

  • Nombre de la tabla: DataSources
  • Extremo: /data-sources
  • Referencia de la API de Klaviyo: Get Data Sources
Nombre del campo Tipo Ruta de JSON Descripción
type STRING $.type Tipo de recurso (siempre data-source).
id STRING $.id Es el identificador único.
title STRING $.attributes.title Es el título de la fuente de datos.
visibility STRING $.attributes.visibility Nivel de visibilidad.
description STRING $.attributes.description Texto de la descripción.

Campañas

Son campañas de marketing que se envían a listas o segmentos.

  • Nombre de la tabla: Campañas
  • Extremo: /campaigns
  • Referencia de la API de Klaviyo: Get Campaigns
Nombre del campo Tipo Ruta de JSON Descripción
type STRING $.type Es el tipo de recurso (siempre campaign).
id STRING $.id Es el identificador único.
name STRING $.attributes.name Es el nombre de la campaña.
status STRING $.attributes.status Estado de la campaña (p. ej., Enviada, Programada)
archived BOOLEAN $.attributes.archived Indica si la campaña está archivada.
included REPEATED STRING $.attributes.audiences.included Son los IDs de las listas o los segmentos incluidos.
excluded REPEATED STRING $.attributes.audiences.excluded Son los IDs de las listas o los segmentos excluidos.
send_options JSON $.attributes.send_options Configuración para el envío (p. ej., envío inteligente)
tracking_options JSON $.attributes.tracking_options Es la configuración para el seguimiento (p.ej., parámetros de UTM).
send_strategy JSON $.attributes.send_strategy Es la estrategia para el tiempo de entrega.
created_at TIMESTAMP $.attributes.created_at Marca de tiempo de creación
scheduled_at TIMESTAMP $.attributes.scheduled_at Cuándo se programó el envío de la campaña
updated_at TIMESTAMP $.attributes.updated_at Es la marca de tiempo de la última actualización.
send_time TIMESTAMP $.attributes.send_time Es la hora real en que se envió el mensaje.
tag_ids REPEATED STRING $.relationships.tags.data[*].id Son los IDs de las etiquetas asociadas.
campaign_message_ids REPEATED STRING $.relationships.campaign-messages.data[*].id Son los IDs de los mensajes incluidos en esta campaña.

CampaignMessages

Mensajes individuales (correo electrónico o SMS) dentro de una campaña

  • Nombre de la tabla: CampaignMessages
  • Extremo: /campaign-messages
  • Referencia de la API de Klaviyo: Get Campaign Message
Nombre del campo Tipo Ruta de JSON Descripción
type STRING $.type Tipo de recurso (siempre campaign-message).
id STRING $.id Es el identificador único.
definition JSON $.attributes.definition Contenido y configuración del mensaje
send_times JSON REPETIDO $.attributes.send_times[*] Horarios de envío programados
created_at TIMESTAMP $.attributes.created_at Marca de tiempo de creación
updated_at TIMESTAMP $.attributes.updated_at Es la marca de tiempo de la última actualización.
campaign_id STRING $.relationships.campaign.data.id Es el ID de la campaña principal.
template_id STRING $.relationships.template.data.id Es el ID de la plantilla utilizada.
image_id STRING $.relationships.image.data.id Es el ID de la imagen adjunta.

Categorías

Son las categorías de productos de tu catálogo.

  • Nombre de la tabla: Categories
  • Extremo: /catalog-categories
  • Referencia de la API de Klaviyo: Get Catalog Categories
Nombre del campo Tipo Ruta de JSON Descripción
type STRING $.type Es el tipo de recurso.
id STRING $.id Es el identificador único.
name STRING $.attributes.name Es el nombre de la categoría.
external_id STRING $.attributes.external_id Es el ID del sistema externo.
updated TIMESTAMP $.attributes.updated Es la marca de tiempo de la última actualización.

Elementos

Son productos o artículos individuales de tu catálogo.

  • Nombre de la tabla: Items
  • Extremo: /catalog-items
  • Referencia de la API de Klaviyo: Get Catalog Items
Nombre del campo Tipo Ruta de JSON Descripción
type STRING $.type Es el tipo de recurso.
id STRING $.id Es el identificador único.
external_id STRING $.attributes.external_id Es el ID del sistema externo.
title STRING $.attributes.title Es el título o nombre del artículo.
description STRING $.attributes.description Descripción disponible.
price FLOAT $.attributes.price Precio del artículo.
url STRING $.attributes.url Es la URL del elemento.
image_full_url STRING $.attributes.image_full_url Es la URL de la imagen en tamaño completo.
image_thumbnail_url STRING $.attributes.image_thumbnail_url Es la URL de la imagen en miniatura.
images REPEATED STRING $.attributes.images[*] Es una lista de URLs de imágenes adicionales.
custom_metadata JSON $.attributes.custom_metadata Son pares clave-valor de metadatos personalizados.
published BOOLEAN $.attributes.published Es el estado de publicación.
created TIMESTAMP $.attributes.created Marca de tiempo de creación
updated TIMESTAMP $.attributes.updated Es la marca de tiempo de la última actualización.
variants_ids REPEATED STRING $.relationships.variants.data[*].id Son los IDs de las variantes de este artículo.

Variantes

Variantes específicas de los artículos del catálogo (p. ej., tamaños y colores)

  • Nombre de la tabla: Variants
  • Extremo: /catalog-variants
  • Referencia de la API de Klaviyo: Get Catalog Variants
Nombre del campo Tipo Ruta de JSON Descripción
type STRING $.type Es el tipo de recurso.
id STRING $.id Es el identificador único.
external_id STRING $.attributes.external_id Es el ID del sistema externo.
title STRING $.attributes.title Título de la variante.
description STRING $.attributes.description Descripción disponible.
sku STRING $.attributes.sku Código de artículo (SKU).
inventory_policy FLOAT $.attributes.inventory_policy Política para la administración de inventario.
inventory_quantity FLOAT $.attributes.inventory_quantity Es la cantidad actual de existencias.
price FLOAT $.attributes.price Precio
url STRING $.attributes.url URL de la variante.
image_full_url STRING $.attributes.image_full_url Indica si está disponible la URL de la imagen completa (booleano).
image_thumbnail_url STRING $.attributes.image_thumbnail_url Es la URL de la imagen en miniatura.
images REPEATED STRING $.attributes.images[*] Es una lista de imágenes.
published BOOLEAN $.attributes.published Es el estado de publicación.
created TIMESTAMP $.attributes.created Marca de tiempo de creación
updated TIMESTAMP $.attributes.updated Es la marca de tiempo de la última actualización.

FlowActions

Son las acciones de flujo asociadas con un flujo.

  • Nombre de la tabla: FlowActions
  • Extremo: /flows/{id}/flow-actions
  • Referencia de la API de Klaviyo: Get Flow Actions
Nombre del campo Tipo Ruta de JSON Descripción
type STRING $.type Es el tipo de recurso. Siempre flow-action.
id STRING $.id Es el identificador único de la acción del flujo.
created TIMESTAMP $.attributes.created Marca de tiempo de creación
updated TIMESTAMP $.attributes.updated Marca de tiempo de la última modificación.
message_id STRING $.attributes.definition.id Es el ID único de la definición del mensaje de acción.
message_temporary_id STRING $.attributes.definition.temporary_id Es el ID temporal asignado a la definición del mensaje.
message_type STRING $.attributes.definition.type Es el tipo de mensaje, como email o sms.
condition_groups REPEATED ConditionGroup $.attributes.definition.data.action_output_filter.condition_groups[*] Son las condiciones asociadas con el filtro de salida de la acción de flujo.
next_if_true STRING $.attributes.definition.links.next_if_true Es el ID de la siguiente acción de flujo si la condición se evalúa como true.
next_if_false STRING $.attributes.definition.links.next_if_false Es el ID de la siguiente acción de flujo si la condición se evalúa como false.

FormVersions

Son las versiones de un formulario determinado.

  • Nombre de la tabla: FormVersions
  • Extremo: /forms/{id}/form-versions
  • Referencia de la API de Klaviyo: Get Form Versions
Nombre del campo Tipo Ruta de JSON Descripción
type STRING $.type Es el tipo de recurso. Siempre form-version.
id STRING $.id Es el identificador único de la versión del formulario.
form_type STRING $.attributes.form_type Es el tipo de formulario, como popup, embed o banner.
variation_name STRING $.attributes.variation_name Es el nombre de la variación del formulario.
ab_test JSON $.attributes.ab_test Configuración de pruebas A/B y de variaciones.
status STRING $.attributes.status Es el estado operativo de la versión del formulario, como draft o live.
created_at TIMESTAMP $.attributes.created_at Marca de tiempo de creación
updated_at TIMESTAMP $.attributes.updated_at Marca de tiempo de la última modificación.

PushTokens

Son los tokens push asociados con los perfiles de apps para dispositivos móviles para las notificaciones push.

  • Nombre de la tabla: PushTokens
  • Extremo: /push-tokens
  • Referencia de la API de Klaviyo: Get Push Tokens
Nombre del campo Tipo Ruta de JSON Descripción
type STRING $.type Es el tipo de recurso. Siempre push-token.
id STRING $.id Es el identificador único del token de envío.
created TIMESTAMP $.attributes.created Marca de tiempo de creación
token STRING $.attributes.token Es la cadena del token de envío del dispositivo.
enablement_status STRING $.attributes.enablement_status Es el estado de habilitación de las notificaciones push, como AUTHORIZED o UNAUTHORIZED.
platform STRING $.attributes.platform Es la plataforma para dispositivos móviles, como ios o android.
vendor STRING $.attributes.vendor Proveedor de servicios, como apns, fcm.
background STRING $.attributes.background Es el estado de actualización en segundo plano de las notificaciones push.
recorded_date TIMESTAMP $.attributes.recorded_date Es la fecha en la que se registró el token de envío.
metadata JSON $.attributes.metadata Metadatos personalizados del dispositivo o del token de envío.
profile_id STRING $.relationships.profile.data.id Es el ID del perfil del cliente asociado con este token de envío.

TagGroups

Son grupos de etiquetas que se usan para organizar y categorizar etiquetas.

  • Nombre de la tabla: TagGroups
  • Extremo: /tag-groups
  • Referencia de la API de Klaviyo: Get Tag Groups
Nombre del campo Tipo Ruta de JSON Descripción
type STRING $.type Es el tipo de recurso. Siempre tag-group.
id STRING $.id Es el identificador único del grupo de etiquetas.
name STRING $.attributes.name Es el nombre del grupo de etiquetas.
exclusive BOOLEAN $.attributes.exclusive Indica si las etiquetas de este grupo son mutuamente excluyentes.
default BOOLEAN $.attributes.default Indica si este es el grupo de etiquetas predeterminado de la cuenta.

UniversalContent

Bloques de contenido universal reutilizables para mensajes y plantillas

  • Nombre de la tabla: UniversalContent
  • Extremo: /template-universal-content
  • Referencia de la API de Klaviyo: Get Universal Content
Nombre del campo Tipo Ruta de JSON Descripción
type STRING $.type Es el tipo de recurso. Siempre template-universal-content.
id STRING $.id Es el identificador único del bloque de contenido universal.
name STRING $.attributes.name Es el nombre del bloque de contenido universal.
definition_content_type STRING $.attributes.definition.content_type Es el tipo de contenido de la definición, como block o template.
definition_type STRING $.attributes.definition.type Es el tipo de componente del contenido, como text, button o image.
definition_data JSON $.attributes.definition.data Son los datos estructurales y la carga útil de la definición del contenido.
created TIMESTAMP $.attributes.created Marca de tiempo de creación
updated TIMESTAMP $.attributes.updated Marca de tiempo de la última modificación.
screenshot_status STRING $.attributes.screenshot_status Es el estado de la generación de capturas de pantalla de vista previa, como completed o pending.
screenshot_url STRING $.attributes.screenshot_url Es la URL pública de la captura de pantalla de la vista previa del contenido.

MetricProperties

Son las propiedades y los atributos estructurales definidos para métricas específicas.

  • Nombre de la tabla: MetricProperties
  • Extremo: /metrics/{id}/metric-properties
  • Referencia de la API de Klaviyo: Get Metric Properties
Nombre del campo Tipo Ruta de JSON Descripción
type STRING $.type Es el tipo de recurso. Siempre metric-property.
id STRING $.id Es el identificador único de la propiedad de la métrica.
sample_values JSON $.attributes.sample_values Son los valores de muestra de datos capturados para esta propiedad de métrica.
label STRING $.attributes.label Es la etiqueta legible por humanos de la propiedad.
property STRING $.attributes.property Es el nombre de la clave de la propiedad del evento.
inferred_type STRING $.attributes.inferred_type Es el tipo de datos que Klaviyo infiere para esta propiedad, como string, boolean o numeric.
metric_id STRING $.relationships.metric.data.id Es el ID de la definición de la métrica superior.

TrackingSettings

Parámetros de seguimiento de UTM a nivel de la cuenta para campañas y flujos.

  • Nombre de la tabla: TrackingSettings
  • Extremo: /tracking-settings
  • Referencia de la API de Klaviyo: Get Tracking Settings
Nombre del campo Tipo Ruta de JSON Descripción
type STRING $.type Es el tipo de recurso. Siempre tracking-setting.
id STRING $.id Es el identificador único de la configuración de seguimiento.
auto_add_parameters BOOLEAN $.attributes.auto_add_parameters Indica si los parámetros de UTM se agregan automáticamente a los vínculos de los mensajes.
utm_source UtmParameter $.attributes.utm_source Es la configuración de _utm_source parameter en flujos y campañas.
utm_medium UtmParameter $.attributes.utm_medium Es la configuración de _utm_medium parameter en flujos y campañas.
utm_campaign UtmParameter $.attributes.utm_campaign Es la configuración del parámetro _utm_campaign en flujos y campañas.
utm_id UtmParameter $.attributes.utm_id Es la configuración del parámetro _utm_id en flujos y campañas.
utm_term UtmParameter $.attributes.utm_term Es la configuración del parámetro _utm_term en flujos y campañas.
custom_parameters REPEATED CustomParameter $.attributes.custom_parameters Son parámetros de seguimiento personalizados que se agregan a los vínculos de campañas y flujos.

UtmParameter

Nombre del campo Tipo Ruta de JSON Descripción
flow ParameterContext flow Contexto de la configuración de parámetros de UTM para los flujos.
campaign ParameterContext campaign Contexto de la configuración de parámetros de UTM para las campañas.

ParameterContext

Nombre del campo Tipo Ruta de JSON Descripción
type STRING type Es el tipo de recurso.
value STRING value Es el valor de la plantilla de parámetro o la clave de atributo, como emailsubject, campaignid.

CustomParameter

Nombre del campo Tipo Ruta de JSON Descripción
flow ParameterContext flow Contexto del parámetro de seguimiento personalizado para los flujos.
campaign ParameterContext campaign Es el contexto del parámetro de seguimiento personalizado para las campañas.
name STRING name Es el nombre del parámetro de seguimiento personalizado.