When you configure an export, import, or other type of flow step using the prebuilt Klaviyo connector, you can select any of the API operations listed below, organized by API type.
Note
If your API endpoint isn’t listed here, switch the flow step toHTTP mode and configure the endpoint provided in the Klaviyo API documentation. You can also create a composite endpoint for this application in HTTP mode.
| Resource | API endpoint | Export | Import |
|---|---|---|---|
| Accounts | Get accounts | X | |
| Get account | X | ||
| Campaigns | Get campaigns | X | |
| Create campaign | X | ||
| Get campaign | X | ||
| Update campaign | X | ||
| Delete campaign | X | ||
| Get campaign message | X | ||
| Update campaign message | X | ||
| Get campaign send job | X | ||
| Update campaign send job | X | ||
| Get campaign recipient estimation job | X | ||
| Get campaign recipient estimation | X | ||
| Create campaign clone | X | ||
| Assign campaign message template | X | ||
| Create campaign send job | X | ||
| Create campaign recipient estimation job | X | ||
| Get campaign ID for campaign message | X | ||
| Get campaign for campaign message | X | ||
| Get template ID for campaign message | X | ||
| Get template for campaign message | X | ||
| Get tag IDs for campaign | X | ||
| Get tags for campaign | X | ||
| Get message IDs for campaign | X | ||
| Get messages for campaign | X | ||
| Get image for campaign message | X | ||
| Get image ID for campaign message | X | ||
| Update campaign message image | X | ||
| Catalogs | Get catalog items | X | |
| Create catalog item | X | ||
| Get catalog item | X | ||
| Update catalog item | X | ||
| Delete catalog item | X | ||
| Get catalog variants | X | ||
| Create catalog variant | X | ||
| Get catalog variant | X | ||
| Update catalog variant | X | ||
| Delete catalog variant | X | ||
| Get catalog categories | X | ||
| Create catalog category | X | ||
| Get catalog category | X | ||
| Update catalog category | X | ||
| Delete catalog category | X | ||
| Get bulk create catalog items jobs | X | ||
| Spawn create items job | X | ||
| Get bulk create catalog items job | X | ||
| Get bulk update catalog items jobs | X | ||
| Spawn update items job | X | ||
| Get bulk update catalog items job | X | ||
| Get bulk delete catalog items jobs | X | ||
| Spawn delete items job | X | ||
| Get bulk delete catalog items job | X | ||
| Get bulk create variants jobs | X | ||
| Spawn create variants job | X | ||
| Get bulk create variants job | X | ||
| Get bulk update variants jobs | X | ||
| Spawn update variants job | X | ||
| Get bulk update variants job | X | ||
| Get bulk delete variants jobs | X | ||
| Spawn delete variants job | X | ||
| Get bulk delete variants job | X | ||
| Get bulk create categories jobs | X | ||
| Spawn create categories job | X | ||
| Get bulk create categories job | X | ||
| Get bulk update categories jobs | X | ||
| Spawn update categories job | X | ||
| Get bulk update categories job | X | ||
| Get bulk delete categories jobs | X | ||
| Spawn delete categories job | X | ||
| Get bulk delete categories job | X | ||
| Create back in stock subscription | X | ||
| Get items for catalog category | X | ||
| Get variants for catalog item | X | ||
| Get categories for catalog item | X | ||
| Get item IDs for catalog category | X | ||
| Create catalog category relationships items | X | ||
| Update catalog category relationships items | X | ||
| Delete catalog category relationships items | X | ||
| Get category IDs for catalog item | X | ||
| Create catalog item relationships categories | X | ||
| Update catalog item relationships categories | X | ||
| Delete catalog item relationships categories | X | ||
| Get variant IDs for catalog item | X | ||
| Client | Create client subscription | X | |
| Create or update client push token | X | ||
| Unregister client push token | X | ||
| Create client event | X | ||
| Create or update client profile | X | ||
| Bulk create client events | X | ||
| Create client back in stock subscription | X | ||
| Get client review values reports | X | ||
| Get client reviews | X | ||
| Create client review | X | ||
| Coupons | Get coupons | X | |
| Create coupon | X | ||
| Get coupon | X | ||
| Update coupon | X | ||
| Delete coupon | X | ||
| Get coupon codes | X | ||
| Create coupon code | X | ||
| Get coupon code | X | ||
| Update coupon code | X | ||
| Delete coupon code | X | ||
| Get coupon code bulk create jobs | X | ||
| Spawn coupon code bulk create job | X | ||
| Get coupon code bulk create job | X | ||
| Get coupon for coupon code | X | ||
| Get coupon relationships coupon codes | X | ||
| Get coupon codes for coupon | X | ||
| Get coupon code relationships coupon | X | ||
| Custom objects | Get data sources | X | |
| Create data source | X | ||
| Get data source | X | ||
| Delete data source | X | ||
| Create data source record job | X | ||
| Data privacy | Request profile deletion | X | |
| Events | Get events | X | |
| Create event | X | ||
| Bulk create events | X | ||
| Get event | X | ||
| Get event metric | X | ||
| Get event profile | X | ||
| Get event relationships metric | X | ||
| Get event relationships profile | X | ||
| Flows | Get flows | X | |
| Get flow | X | ||
| Update flow status | X | ||
| Delete flow | X | ||
| Get flow action | X | ||
| Get flow message | X | ||
| Get actions for flow | X | ||
| Get action IDs for flow | X | ||
| Get tag IDs for flow | X | ||
| Get tags for flow | X | ||
| Get flow for flow action | X | ||
| Get flow ID for flow action | X | ||
| Get messages for flow action | X | ||
| Get message IDs for flow action | X | ||
| Get action for flow message | X | ||
| Get action ID for flow message | X | ||
| Create flow | X | ||
| Forms | Get forms | X | |
| Get form | X | ||
| Delete form | X | ||
| Get form version | X | ||
| Get versions for form | X | ||
| Get version IDs for form | X | ||
| Get form for form version | X | ||
| Get form ID for form version | X | ||
| Images | Get images | X | |
| Upload image from URL | X | ||
| Get image | X | ||
| Update image | X | ||
| Upload image from file | X | ||
| Lists | Get lists | X | |
| Create list | X | ||
| Get list | X | ||
| Update list | X | ||
| Delete list | X | ||
| Get tag IDs for list | X | ||
| Get tags for list | X | ||
| Get profile IDs for list | X | ||
| Add profile to list | X | ||
| Remove profile from list | X | ||
| Get profiles for list | X | ||
| Get flows triggered by list | X | ||
| Get IDs for flows triggered by list | X | ||
| Metrics | Get metrics | X | |
| Get metric | X | ||
| Get IDs for flows triggered by metric | X | ||
| Query metric aggregates | X | ||
| Get custom metrics | X | ||
| Get custom metric | X | ||
| Get metrics for custom metric | X | ||
| Get metric IDs for custom metric | X | ||
| Get mapped metrics | X | ||
| Get mapped metric | X | ||
| Get metric for mapped metric | X | ||
| Get metric ID for mapped metric | X | ||
| Get custom metric for mapped metric | X | ||
| Get custom metric ID for mapped metric | X | ||
| Update mapped metric | X | ||
| Create custom metric | X | ||
| Update custom metric | X | ||
| Delete custom metric | X | ||
| Get metric property | X | ||
| Get metric for metric property | X | ||
| Get metric ID for metric property | X | ||
| Get properties for metric | X | ||
| Get property IDs for metric | X | ||
| Get flows triggered by metric | X | ||
| Profiles | Get profiles | X | |
| Create profile | X | ||
| Get profile | X | ||
| Update profile | X | ||
| Get bulk import profiles jobs | X | ||
| Spawn bulk profile import job | X | ||
| Get bulk import profiles job | X | ||
| Create or update profile | X | ||
| Merge profiles | X | ||
| Suppress profiles | X | ||
| Unsuppress profiles | X | ||
| Subscribe profiles | X | ||
| Unsubscribe profiles | X | ||
| Create or update push token | X | ||
| Get profile lists | X | ||
| Get profile relationships lists | X | ||
| Get profile segments | X | ||
| Get profile relationships segments | X | ||
| Get list for bulk import profiles job | X | ||
| Get list IDs for bulk import profiles job | X | ||
| Get profiles for bulk import profiles job | X | ||
| Get profile IDs for bulk import profiles job | X | ||
| Get errors for bulk import profiles job | X | ||
| Get push tokens | X | ||
| Get push token | X | ||
| Get profile for push token | X | ||
| Get profile ID for push token | X | ||
| Get bulk suppress profiles jobs | X | ||
| Get bulk suppress profiles job | X | ||
| Get bulk unsuppress profiles jobs | X | ||
| Get bulk unsuppress profiles job | X | ||
| Get push tokens for profile | X | ||
| Get push token IDs for profile | X | ||
| Reporting | Query campaign values | X | |
| Query flow values | X | ||
| Query flow series | X | ||
| Query form values | X | ||
| Query form series | X | ||
| Query segment values | X | ||
| Query segment series | X | ||
| Reviews | Get reviews | X | |
| Get review | X | ||
| Update review | X | ||
| Get reviews | X | ||
| Segments | Get segments | X | |
| Get segment | X | ||
| Create segment | X | ||
| Delete segment | X | ||
| Update segment | X | ||
| Get segment relationships tags | X | ||
| Get segment tags | X | ||
| Get segment relationships profiles | X | ||
| Get segment profiles | X | ||
| Get flows triggered by segment | X | ||
| Get IDs for flows triggered by segment | X | ||
| Tags | Get tags | X | |
| Create tag | X | ||
| Get tag | X | ||
| Update tag | X | ||
| Delete tag | X | ||
| Get tag groups | X | ||
| Create tag group | X | ||
| Get tag group | X | ||
| Update tag group | X | ||
| Delete tag group | X | ||
| Get tag relationships flows | X | ||
| Create tag relationships flows | X | ||
| Delete tag relationships flows | X | ||
| Get tag relationships campaigns | X | ||
| Create tag relationships campaigns | X | ||
| Delete tag relationships campaigns | X | ||
| Get tag relationships lists | X | ||
| Create tag relationships lists | X | ||
| Delete tag relationships lists | X | ||
| Get tag relationships segments | X | ||
| Create tag relationships segments | X | ||
| Delete tag relationships segments | X | ||
| Get tag group ID for tag | X | ||
| Get tag IDs for tag group | X | ||
| Get tag group for tag | X | ||
| Get tags for tag group | X | ||
| Templates | Get template ID for flow message | X | |
| Get template for flow message | X | ||
| Get templates | X | ||
| Create template | X | ||
| Get template | X | ||
| Update template | X | ||
| Delete template | X | ||
| Create template render | X | ||
| Create template clone | X | ||
| Create universal content | X | ||
| Update universal content | X | ||
| Delete universal content | X | ||
| Get all universal content | X | ||
| Get universal content | X | ||
| Tracking settings | Get tracking settings | X | |
| Get tracking setting | X | ||
| Update tracking setting | X | ||
| Webfeed | Get web feeds | X | |
| Create web feed | X | ||
| Get web feed | X | ||
| Update web feed | X | ||
| Delete web feed | X | ||
| Webhooks | Get webhooks | X | |
| Create webhook | X | ||
| Get webhook | X | ||
| Update webhook | X | ||
| Delete webhook | X | ||
| Get webhook topics | X | ||
| Get webhook topic | X |
Available DI objects
The following objects are available when using Klaviyo as a source in Celigo Data Integration (DI).
Primary key: All Klaviyo DI endpoints use id as the primary key. Klaviyo follows the JSON:API specification, so every resource object has a top-level id field with a consistent structure.
Note
Klaviyo hard deletes records. Deleted records are not retrievable via the API. Celigo syncs all data returned by the source as-is.
| Object | API endpoint | Available extract modes | Delta field |
|---|---|---|---|
| Campaigns | Get campaigns | Full, Incremental | filter |
| Catalog categories | Get catalog categories | Full | - |
| Catalog items | Get catalog items | Full | - |
| Catalog variants | Get catalog variants | Full | - |
| Coupons | Get coupons | Full | - |
| Events | Get events | Full, Incremental | filter |
| Flows | Get flows | Full, Incremental | filter |
| Lists | Get lists | Full, Incremental | filter |
| Metrics | Get metrics | Full | - |
| Profiles | Get profiles | Full, Incremental | filter |
| Segments | Get segments | Full, Incremental | filter |
| Tags | Get tags | Full | — |
Response schemas
Click an object below to view its response fields and delta configuration.
Campaigns — Get campaigns
Delta configuration: use it to request incremental data.
| Setting | Value |
|---|---|
| Delta filter | greater-than(updated_at,{{{lastExportDateTime}}}) |
| Date format | YYYY-MM-DDTHH:mm:ss[Z] |
Response schema:
| Field | Type |
|---|---|
id |
string (Primary key) |
attributes |
object |
attributes.name |
string |
attributes.status |
string |
attributes.archived |
boolean |
attributes.send_time |
string |
attributes.created_at |
string |
attributes.updated_at |
string |
attributes.campaign_type |
string |
Catalog categories — Get catalog categories
Response schema:
| Field | Type |
|---|---|
id |
string (Primary key) |
type |
string |
attributes |
object |
attributes.external_id |
string |
attributes.name |
string |
attributes.updated |
string |
relationships |
object |
relationships.items |
object |
relationships.items.data |
objectarray |
relationships.items.data.type |
string |
relationships.items.data.id |
string |
relationships.items.links |
object |
relationships.items.links.self |
string |
relationships.items.links.related |
string |
links |
object |
links.self |
string |
Catalog items — Get catalog items
Response schema:
| Field | Type |
|---|---|
type |
string |
id |
string (Primary key) |
attributes |
object |
attributes.external_id |
string |
attributes.title |
string |
attributes.description |
string |
attributes.price |
number |
attributes.url |
string |
attributes.image_full_url |
string |
attributes.image_thumbnail_url |
string |
attributes.images |
stringarray |
attributes.custom_metadata |
object |
attributes.published |
boolean |
attributes.created |
string |
attributes.updated |
string |
relationships |
object |
relationships.variants |
object |
relationships.variants.data |
objectarray |
relationships.variants.data.type |
string |
relationships.variants.data.id |
string |
relationships.variants.links |
object |
relationships.variants.links.self |
string |
relationships.variants.links.related |
string |
links |
object |
links.self |
string |
Catalog variants — Get catalog variants
Response schema:
| Field | Type |
|---|---|
id |
string (Primary key) |
type |
string |
attributes |
object |
attributes.external_id |
string |
attributes.title |
string |
attributes.description |
string |
attributes.sku |
string |
attributes.inventory_policy |
number |
attributes.inventory_quantity |
number |
attributes.price |
number |
attributes.url |
string |
attributes.image_full_url |
string |
attributes.image_thumbnail_url |
string |
attributes.images |
stringarray |
attributes.custom_metadata |
object |
attributes.published |
boolean |
attributes.created |
string |
attributes.updated |
string |
relationships |
object |
relationships.item |
object |
relationships.item.data |
object |
relationships.item.data.type |
string |
relationships.item.data.id |
string |
relationships.item.links |
object |
relationships.item.links.self |
string |
relationships.item.links.related |
string |
links |
object |
links.self |
string |
Coupons — Get coupons
Response schema:
| Field | Type |
|---|---|
type |
string |
id |
string (Primary key) |
attributes |
object |
attributes.external_id |
string |
attributes.description |
string |
attributes.monitor_configuration |
object |
attributes.monitor_configuration.low_balance_threshold |
number |
links |
object |
links.self |
string |
Events — Get events
Delta configuration: use it to request incremental data.
| Setting | Value |
|---|---|
| Delta filter | greater-than(datetime,{{{lastExportDateTime}}}) |
| Date format | YYYY-MM-DDTHH:mm:ss[Z] |
Response schema:
| Field | Type |
|---|---|
type |
string |
id |
string (Primary key) |
attributes |
object |
attributes.timestamp |
string |
attributes.event_properties |
object |
attributes.datetime |
string |
attributes.uuid |
string |
relationships |
object |
relationships.profile |
object |
relationships.profile.data |
object |
relationships.profile.data.type |
string |
relationships.profile.data.id |
string |
relationships.profile.links |
object |
relationships.profile.links.self |
string |
relationships.profile.links.related |
string |
relationships.metric |
object |
relationships.metric.data |
object |
relationships.metric.data.type |
string |
relationships.metric.data.id |
string |
relationships.metric.links |
object |
relationships.metric.links.self |
string |
relationships.metric.links.related |
string |
relationships.attributions |
object |
relationships.attributions.data |
objectarray |
relationships.attributions.data.type |
string |
relationships.attributions.data.id |
string |
relationships.attributions.links |
object |
relationships.attributions.links.self |
string |
relationships.attributions.links.related |
string |
links |
object |
links.self |
string |
Flows — Get flows
Delta configuration: use it to request incremental data.
| Setting | Value |
|---|---|
| Delta filter | greater-than(updated,{{{lastExportDateTime}}}) |
| Date format | YYYY-MM-DDTHH:mm:ss[Z] |
Response schema:
| Field | Type |
|---|---|
type |
string |
id |
string (Primary key) |
attributes |
object |
attributes.name |
string |
attributes.status |
string |
attributes.archived |
boolean |
attributes.created |
string |
attributes.updated |
string |
attributes.trigger_type |
string |
relationships |
object |
relationships.flow-actions |
object |
relationships.flow-actions.data |
objectarray |
relationships.flow-actions.data.type |
string |
relationships.flow-actions.data.id |
string |
relationships.flow-actions.links |
object |
relationships.flow-actions.links.self |
string |
relationships.flow-actions.links.related |
string |
relationships.tags |
object |
relationships.tags.data |
objectarray |
relationships.tags.data.type |
string |
relationships.tags.data.id |
string |
relationships.tags.links |
object |
relationships.tags.links.self |
string |
relationships.tags.links.related |
string |
links |
object |
links.self |
string |
Lists — Get lists
Delta configuration: use it to request incremental data.
| Setting | Value |
|---|---|
| Delta filter | greater-than(updated,{{{lastExportDateTime}}}) |
| Date format | YYYY-MM-DDTHH:mm:ss[Z] |
Response schema:
| Field | Type |
|---|---|
type |
string |
id |
string (Primary key) |
attributes |
object |
attributes.name |
string |
attributes.created |
string |
attributes.updated |
string |
attributes.opt_in_process |
string |
relationships |
object |
relationships.profiles |
object |
relationships.profiles.data |
objectarray |
relationships.profiles.data.type |
string |
relationships.profiles.data.id |
string |
relationships.profiles.links |
object |
relationships.profiles.links.self |
string |
relationships.profiles.links.related |
string |
relationships.tags |
object |
relationships.tags.data |
objectarray |
relationships.tags.data.type |
string |
relationships.tags.data.id |
string |
relationships.tags.links |
object |
relationships.tags.links.self |
string |
relationships.tags.links.related |
string |
relationships.flow-triggers |
object |
relationships.flow-triggers.data |
objectarray |
relationships.flow-triggers.data.type |
string |
relationships.flow-triggers.data.id |
string |
relationships.flow-triggers.links |
object |
relationships.flow-triggers.links.self |
string |
relationships.flow-triggers.links.related |
string |
links |
object |
links.self |
string |
Metrics — Get metrics
Response schema:
| Field | Type |
|---|---|
type |
string |
id |
string (Primary key) |
attributes |
object |
attributes.name |
string |
attributes.created |
string |
attributes.updated |
string |
attributes.integration |
object |
relationships |
object |
relationships.flow-triggers |
object |
relationships.flow-triggers.data |
objectarray |
relationships.flow-triggers.data.type |
string |
relationships.flow-triggers.data.id |
string |
relationships.flow-triggers.links |
object |
relationships.flow-triggers.links.self |
string |
relationships.flow-triggers.links.related |
string |
links |
object |
links.self |
string |
Profiles — Get profiles
Delta configuration: use it to request incremental data.
| Setting | Value |
|---|---|
| Delta filter | greater-than(updated,{{{lastExportDateTime}}}) |
| Date format | YYYY-MM-DDTHH:mm:ss[Z] |
Response schema:
| Field | Type |
|---|---|
type |
string |
attributes |
object |
attributes.subscriptions |
object |
attributes.subscriptions.email |
object |
attributes.subscriptions.email.marketing |
object |
attributes.subscriptions.email.marketing.can_receive_email_marketing |
boolean |
attributes.subscriptions.email.marketing.consent |
string |
attributes.subscriptions.email.marketing.consent_timestamp |
string |
attributes.subscriptions.email.marketing.last_updated |
string |
attributes.subscriptions.email.marketing.method |
string |
attributes.subscriptions.email.marketing.method_detail |
string |
attributes.subscriptions.email.marketing.custom_method_detail |
string |
attributes.subscriptions.email.marketing.double_optin |
boolean |
attributes.subscriptions.email.marketing.suppression |
objectarray |
attributes.subscriptions.email.marketing.suppression.reason |
string |
attributes.subscriptions.email.marketing.suppression.timestamp |
string |
attributes.subscriptions.email.marketing.list_suppressions |
objectarray |
attributes.subscriptions.email.marketing.list_suppressions.list_id |
string |
attributes.subscriptions.email.marketing.list_suppressions.reason |
string |
attributes.subscriptions.email.marketing.list_suppressions.timestamp |
string |
attributes.subscriptions.sms |
object |
attributes.subscriptions.sms.marketing |
object |
attributes.subscriptions.sms.marketing.can_receive_sms_marketing |
boolean |
attributes.subscriptions.sms.marketing.consent |
string |
attributes.subscriptions.sms.marketing.consent_timestamp |
string |
attributes.subscriptions.sms.marketing.method |
string |
attributes.subscriptions.sms.marketing.method_detail |
string |
attributes.subscriptions.sms.marketing.last_updated |
string |
attributes.subscriptions.sms.transactional |
object |
attributes.subscriptions.sms.transactional.can_receive_sms_transactional |
boolean |
attributes.subscriptions.sms.transactional.consent |
string |
attributes.subscriptions.sms.transactional.consent_timestamp |
string |
attributes.subscriptions.sms.transactional.method |
string |
attributes.subscriptions.sms.transactional.method_detail |
string |
attributes.subscriptions.sms.transactional.last_updated |
string |
attributes.subscriptions.mobile_push |
object |
attributes.subscriptions.mobile_push.marketing |
object |
attributes.subscriptions.mobile_push.marketing.can_receive_push_marketing |
boolean |
attributes.subscriptions.mobile_push.marketing.consent |
string |
attributes.subscriptions.mobile_push.marketing.consent_timestamp |
string |
attributes.subscriptions.whatsapp |
object |
attributes.subscriptions.whatsapp.marketing |
object |
attributes.subscriptions.whatsapp.marketing.consent |
string |
attributes.subscriptions.whatsapp.marketing.consent_timestamp |
string |
attributes.subscriptions.whatsapp.marketing.last_updated |
string |
attributes.subscriptions.whatsapp.marketing.created_timestamp |
string |
attributes.subscriptions.whatsapp.marketing.metadata |
object |
attributes.subscriptions.whatsapp.marketing.can_receive |
boolean |
attributes.subscriptions.whatsapp.marketing.valid_until |
string |
attributes.subscriptions.whatsapp.marketing.phone_number |
string |
attributes.subscriptions.whatsapp.transactional |
object |
attributes.subscriptions.whatsapp.transactional.consent |
string |
attributes.subscriptions.whatsapp.transactional.consent_timestamp |
string |
attributes.subscriptions.whatsapp.transactional.last_updated |
string |
attributes.subscriptions.whatsapp.transactional.created_timestamp |
string |
attributes.subscriptions.whatsapp.transactional.metadata |
object |
attributes.subscriptions.whatsapp.transactional.can_receive |
boolean |
attributes.subscriptions.whatsapp.transactional.valid_until |
string |
attributes.subscriptions.whatsapp.transactional.phone_number |
string |
attributes.subscriptions.whatsapp.conversational |
object |
attributes.subscriptions.whatsapp.conversational.consent |
string |
attributes.subscriptions.whatsapp.conversational.consent_timestamp |
string |
attributes.subscriptions.whatsapp.conversational.last_updated |
string |
attributes.subscriptions.whatsapp.conversational.created_timestamp |
string |
attributes.subscriptions.whatsapp.conversational.metadata |
object |
attributes.subscriptions.whatsapp.conversational.can_receive |
boolean |
attributes.subscriptions.whatsapp.conversational.valid_until |
string |
attributes.subscriptions.whatsapp.conversational.phone_number |
string |
attributes.predictive_analytics |
object |
attributes.predictive_analytics.historic_clv |
number |
attributes.predictive_analytics.predicted_clv |
number |
attributes.predictive_analytics.total_clv |
number |
attributes.predictive_analytics.historic_number_of_orders |
number |
attributes.predictive_analytics.predicted_number_of_orders |
number |
attributes.predictive_analytics.average_days_between_orders |
number |
attributes.predictive_analytics.average_order_value |
number |
attributes.predictive_analytics.churn_probability |
number |
attributes.predictive_analytics.expected_date_of_next_order |
string |
attributes.predictive_analytics.ranked_channel_affinity |
stringarray |
attributes.email |
string |
attributes.phone_number |
string |
attributes.external_id |
string |
attributes.first_name |
string |
attributes.last_name |
string |
attributes.organization |
string |
attributes.locale |
string |
attributes.title |
string |
attributes.image |
string |
attributes.created |
string |
attributes.updated |
string |
attributes.last_event_date |
string |
attributes.location |
object |
attributes.location.address1 |
string |
attributes.location.address2 |
string |
attributes.location.city |
string |
attributes.location.country |
string |
attributes.location.latitude |
string |
attributes.location.longitude |
string |
attributes.location.region |
string |
attributes.location.zip |
string |
attributes.location.timezone |
string |
attributes.location.ip |
string |
attributes.properties |
object |
attributes.properties.pseudonym |
string |
id |
string (Primary key) |
relationships |
object |
relationships.lists |
object |
relationships.lists.data |
objectarray |
relationships.lists.data.type |
string |
relationships.lists.data.id |
string |
relationships.lists.links |
object |
relationships.lists.links.self |
string |
relationships.lists.links.related |
string |
relationships.segments |
object |
relationships.segments.data |
objectarray |
relationships.segments.data.type |
string |
relationships.segments.data.id |
string |
relationships.segments.links |
object |
relationships.segments.links.self |
string |
relationships.segments.links.related |
string |
relationships.push-tokens |
object |
relationships.push-tokens.data |
objectarray |
relationships.push-tokens.data.type |
string |
relationships.push-tokens.data.id |
string |
relationships.push-tokens.links |
object |
relationships.push-tokens.links.self |
string |
relationships.push-tokens.links.related |
string |
links |
object |
links.self |
string |
Segments — Get segments
Delta configuration: use it to request incremental data.
| Setting | Value |
|---|---|
| Delta filter | greater-than(updated,{{{lastExportDateTime}}}) |
| Date format | YYYY-MM-DDTHH:mm:ss[Z] |
Response schema:
| Field | Type |
|---|---|
id |
string (Primary key) |
type |
string |
attributes |
object |
attributes.name |
string |
attributes.definition |
object |
attributes.definition.condition_groups |
objectarray |
attributes.definition.condition_groups.conditions |
objectarray |
attributes.definition.condition_groups.conditions.type |
string |
attributes.definition.condition_groups.conditions.is_member |
boolean |
attributes.definition.condition_groups.conditions.group_ids |
stringarray |
attributes.definition.condition_groups.conditions.timeframe_filter |
object |
attributes.definition.condition_groups.conditions.timeframe_filter.type |
string |
attributes.definition.condition_groups.conditions.timeframe_filter.operator |
string |
attributes.definition.condition_groups.conditions.timeframe_filter.date |
string |
attributes.definition.condition_groups.conditions.metric_id |
string |
attributes.definition.condition_groups.conditions.measurement |
string |
attributes.definition.condition_groups.conditions.measurement_filter |
object |
attributes.definition.condition_groups.conditions.measurement_filter.type |
string |
attributes.definition.condition_groups.conditions.measurement_filter.operator |
string |
attributes.definition.condition_groups.conditions.measurement_filter.value |
number |
attributes.definition.condition_groups.conditions.metric_filters |
objectarray |
attributes.definition.condition_groups.conditions.metric_filters.property |
string |
attributes.definition.condition_groups.conditions.metric_filters.filter |
object |
attributes.definition.condition_groups.conditions.metric_filters.filter.type |
string |
attributes.definition.condition_groups.conditions.metric_filters.filter.operator |
string |
attributes.definition.condition_groups.conditions.metric_filters.filter.value |
string |
attributes.definition.condition_groups.conditions.consent |
object |
attributes.definition.condition_groups.conditions.consent.channel |
string |
attributes.definition.condition_groups.conditions.consent.can_receive_marketing |
boolean |
attributes.definition.condition_groups.conditions.consent.consent_status |
object |
attributes.definition.condition_groups.conditions.consent.consent_status.subscription |
string |
attributes.definition.condition_groups.conditions.country_code |
string |
attributes.definition.condition_groups.conditions.postal_code |
string |
attributes.definition.condition_groups.conditions.unit |
string |
attributes.definition.condition_groups.conditions.filter |
object |
attributes.definition.condition_groups.conditions.filter.type |
string |
attributes.definition.condition_groups.conditions.filter.operator |
string |
attributes.definition.condition_groups.conditions.filter.value |
number |
attributes.definition.condition_groups.conditions.property |
string |
attributes.definition.condition_groups.conditions.in_region |
boolean |
attributes.definition.condition_groups.conditions.region |
string |
attributes.definition.condition_groups.conditions.dimension |
string |
attributes.definition.condition_groups.conditions.predicted_channel |
string |
attributes.definition.condition_groups.conditions.object_type_id |
string |
attributes.definition.condition_groups.conditions.object_type_relationship_id |
string |
attributes.definition.condition_groups.conditions.filters |
objectarray |
attributes.definition.condition_groups.conditions.filters.property_id |
number |
attributes.definition.condition_groups.conditions.filters.filter |
object |
attributes.definition.condition_groups.conditions.filters.filter.type |
string |
attributes.definition.condition_groups.conditions.filters.filter.operator |
string |
attributes.definition.condition_groups.conditions.filters.filter.value |
string |
attributes.definition.condition_groups.conditions.permission |
object |
attributes.definition.condition_groups.conditions.permission.reachable_status |
string |
attributes.definition.condition_groups.conditions.permission.filters |
objectarray |
attributes.definition.condition_groups.conditions.permission.filters.field |
string |
attributes.definition.condition_groups.conditions.permission.filters.filter |
object |
attributes.definition.condition_groups.conditions.permission.filters.filter.type |
string |
attributes.definition.condition_groups.conditions.permission.filters.filter.operator |
string |
attributes.definition.condition_groups.conditions.permission.filters.filter.date |
string |
attributes.definition.condition_groups.conditions.permission.filters.method |
string |
attributes.definition.condition_groups.conditions.channel |
string |
attributes.definition.condition_groups.conditions.completion_window_seconds |
string |
attributes.definition.condition_groups.conditions.steps |
objectarray |
attributes.definition.condition_groups.conditions.steps.metric_exists |
boolean |
attributes.definition.condition_groups.conditions.steps.metric_id |
string |
attributes.definition.condition_groups.conditions.steps.metric_filters |
objectarray |
attributes.definition.condition_groups.conditions.steps.metric_filters.property |
string |
attributes.definition.condition_groups.conditions.steps.metric_filters.filter |
object |
attributes.definition.condition_groups.conditions.steps.metric_filters.filter.type |
string |
attributes.definition.condition_groups.conditions.steps.metric_filters.filter.operator |
string |
attributes.definition.condition_groups.conditions.steps.metric_filters.filter.value |
string |
attributes.created |
string |
attributes.updated |
string |
attributes.is_active |
boolean |
attributes.is_processing |
boolean |
attributes.is_starred |
boolean |
relationships |
object |
relationships.profiles |
object |
relationships.profiles.data |
objectarray |
relationships.profiles.data.type |
string |
relationships.profiles.data.id |
string |
relationships.profiles.links |
object |
relationships.profiles.links.self |
string |
relationships.profiles.links.related |
string |
relationships.tags |
object |
relationships.tags.data |
objectarray |
relationships.tags.data.type |
string |
relationships.tags.data.id |
string |
relationships.tags.links |
object |
relationships.tags.links.self |
string |
relationships.tags.links.related |
string |
relationships.flow-triggers |
object |
relationships.flow-triggers.data |
objectarray |
relationships.flow-triggers.data.type |
string |
relationships.flow-triggers.data.id |
string |
relationships.flow-triggers.links |
object |
relationships.flow-triggers.links.self |
string |
relationships.flow-triggers.links.related |
string |
links |
object |
links.self |
string |