Segment

Segment is Twilio's Customer Data Platform (CDP). It collects customer event data from websites, mobile apps, and server-side systems and routes it to analytics tools, marketing platforms, and data warehouse destinations.

Segment integration replicates data using the Segment Public API.

This connector replicates workspace configuration and operational metrics from Segment. It does not replicate raw analytics events (track, identify, page, screen, or group calls).

See the Schema section for a list of objects available for replication.

A high-level look at this connector, including useful links, and supported features.

Feature/Capability	Support details
Supported Qlik Talend Data Integration projects	Replication projects only. Data pipeline projects are not supported.
Target update methods	Replication tasks: Apply changes Store changes Landing data in a data lake tasks: Change data capture (CDC)
Managing metadata	Manual metadata generation is not required.
Schema evolution	Only the Change column data type operation is supported.
Replication of LOB columns (NCLOB, CLOB, and BLOB)	Not supported.
Scheduled CDC	Required. This is how the target is kept up-to-date with changes to the source. For replication tasks, see Scheduling tasks For lake landing tasks, see Scheduling CDC for lake landing tasks
Notifications	Partially supported Setting notifications for changes in operation
Monitoring	CDC-only, as full load is not relevant for this connector. Monitoring an individual data task
Automatic denesting of JSON column payloads	Not supported. JSON column payloads in source datasets are not denested automatically on the target.

Preparing for authentication

To access your data, you need to authenticate the connection with a Segment Public API token.

Make sure that the account you use has read access to the tables you want to fetch.

To set up your Segment account, you need:

An active Segment workspace on a Team or Business tier plan. Free and Starter plans have limited Segment Public API support, and some streams may return 403 errors.
A Segment user with Workspace Owner or Workspace Member role (required to create API tokens).

To create an API token:

Log into your Segment account.
Navigate to Settings > Workspace settings.
Select the Access Management tab.
Click the Tokens tab.
Click + Create Token.
Enter a description for the token, for example QlikDataIntegration.
Select Workspace Member access, which is sufficient for read-only access to workspace data.
Click Create.
Copy and paste your API token into a secured file.

Creating the connection

For more information, see Connecting to SaaS applications.

Fill in the required connection properties.
Provide a name for the connection in Connection name.
Select Open connection metadata to define metadata for the connection when it has been created.
Click Create.

Connection settings
Setting	Description
Data gateway	Select a Data Movement gateway if required by your use case. Information note This field is not available with the Qlik Talend Cloud Starter subscription, as it does not support Data Movement gateway. If you have another subscription tier and do not want to use Data Movement gateway, select None. For information on the benefits of Data Movement gateway and use cases that require it, see Qlik Data Gateway - Data Movement.
Start Date	Enter the date, in the format `MM/DD/YYYY`, from which the data must be replicated from your source to your target.
API Token	API token.

Limitations and considerations

The Segment Public API requires a Team or Business tier plan for full access. Some endpoints may return 403 errors on Free or Starter plans.
The audit_events stream requires the Audit Trail feature, which is available on Business tier plans only. Team tier accounts and below should de-select audit_events before syncing to avoid 403 errors.
Usage metric streams (usage_api_calls_per_source_daily, usage_api_calls_workspace_daily, usage_mtu_per_source_daily, and usage_mtu_workspace_daily) paginate through data month by month from the configured start date. The day-of-month component of the start date is ignored for these streams — data is fetched from the first day of the calendar month containing the start date. Initial syncs may take longer when the start date is set far in the past.
As of February 1, 2024, Segment no longer supports creating Config API tokens. Only Public API tokens are supported.

Schema

Schemas and naming conventions can change from version to version. It is recommended to verify your version before continuing.

Depending on your destination, table and column names may not appear as they are outlined below.

audit_events

The audit_events table contains the workspace audit trail, including user actions and configuration changes. Requires the Audit Trail feature (Business tier).

Replication Method	CDC
Primary Key	id
Replication Key	timestamp
Useful links	Segment Public API reference

catalog_destinations

The catalog_destinations table contains all available destination types from the Segment Destinations Catalog, across all workspaces.

Replication Method	Full Table
Primary Key	id
Useful links	Segment Public API reference

catalog_sources

The catalog_sources table contains all available source types from the Segment Sources Catalog, across all workspaces.

Replication Method	Full Table
Primary Key	id
Useful links	Segment Public API reference

catalog_warehouses

The catalog_warehouses table contains all available warehouse types from the Segment Warehouses Catalog, across all workspaces.

Replication Method	Full Table
Primary Key	id
Useful links	Segment Public API reference

destination_delivery_metrics_summary

The destination_delivery_metrics_summary table contains delivery metrics for each source-to-destination pair in the workspace.

Replication Method	Full Table
Primary Key	sourceId, destinationId
Useful links	Segment Public API reference

destination_subscriptions

The destination_subscriptions table contains event subscriptions configured per destination in the workspace.

Replication Method	Full Table
Primary Key	id
Useful links	Segment Public API reference

destinations

The destinations table contains data destinations configured in the workspace.

Replication Method	Full Table
Primary Key	id, sourceId
Useful links	Segment Public API reference

groups

The groups table contains user groups configured in the workspace.

Replication Method	Full Table
Primary Key	id
Useful links	Segment Public API reference

source_connected_destinations

The source_connected_destinations table contains source-to-destination connections in the workspace.

Replication Method	Full Table
Primary Key	id, sourceId
Useful links	Segment Public API reference

source_connected_warehouses

The source_connected_warehouses table contains source-to-warehouse connections in the workspace.

Replication Method	Full Table
Primary Key	sourceId
Useful links	Segment Public API reference

sources

The sources table contains data sources configured in the workspace.

Replication Method	Full Table
Primary Key	id
Useful links	Segment Public API reference

transformations

The transformations table contains data transformations configured in the workspace.

Replication Method	Full Table
Primary Key	id
Useful links	Segment Public API reference

usage_api_calls_per_source_daily

The usage_api_calls_per_source_daily table contains daily API call usage broken down by source.

Replication Method	CDC
Primary Key	sourceId
Replication Key	timestamp
Useful links	Segment Public API reference

usage_api_calls_workspace_daily

The usage_api_calls_workspace_daily table contains daily total API call usage for the workspace.

Replication Method	CDC
Primary Key	timestamp
Replication Key	timestamp
Useful links	Segment Public API reference

usage_mtu_per_source_daily

The usage_mtu_per_source_daily table contains daily Monthly Tracked Users (MTU) usage broken down by source.

Replication Method	CDC
Primary Key	sourceId
Replication Key	timestamp
Useful links	Segment Public API reference

usage_mtu_workspace_daily

The usage_mtu_workspace_daily table contains daily total Monthly Tracked Users (MTU) usage for the workspace.

Replication Method	CDC
Primary Key	timestamp
Replication Key	timestamp
Useful links	Segment Public API reference

users

The users table contains users with access to the workspace.

Replication Method	Full Table
Primary Key	id
Useful links	Segment Public API reference

warehouses

The warehouses table contains warehouse connections configured in the workspace.

Replication Method	Full Table
Primary Key	id
Useful links	Segment Public API reference

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – please let us know!

Leave your feedback here