Connecting to CustomerIO

Using API Key Authentication

To obtain your Customer.io App API Key, navigate to the Customer.io UI under Data & Integrations > Integrations > Customer.io API and generate your API key.

After setting the following connection properties, you are ready to connect:

AuthScheme: Set this to APIKey.
APIKey: Set this to your Customer.io App API Key.

Example Connection String

Profile=C:\profiles\CustomerIO.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your_api_key";

Available Tables

The CustomerIO API Profile provides access to comprehensive customer engagement and marketing automation data across 27 specialized tables:

Customers - Access customer profile data with email addresses and Customer.io identifiers.
Activities - Query customer activity tracking data including email and SMS activities.
Campaigns - Access campaign definitions and configuration from Customer.io campaigns.
Broadcasts - Retrieve broadcast campaign data with scheduling and targeting information.
Segments - Query customer segmentation definitions and configuration.
Collections - Access data collections and schema definitions.
Exports - Query data export operations and status tracking.
TransactionalMessages - Access transactional email and message data.
Workspaces - Query workspace configuration and settings.
CustomerAttributes - Access detailed customer attributes and metadata.
CustomerMessages - Query customer-specific message history and delivery data.
BroadcastMessages - Access broadcast message details and delivery status.
CampaignMessages - Query campaign message data with performance metrics.
CustomerActivities - Access customer-specific activity data and engagement metrics.
SenderIdentities - Query email sender identity configurations.
Snippets - Access reusable content snippets and templates.
Imports - Query data import operations and status tracking.
SubscriptionTopics - Access subscription topic definitions and preferences.
CustomerSegments - Query customer segment membership data.
CustomerSubscriptionPreferences - Access customer subscription preference settings.
ESPSuppressions - Query email service provider suppression lists.
BroadcastActions - Access broadcast action details and configuration.
CampaignActions - Query campaign action details and configuration.
BroadcastTriggers - Access broadcast trigger definitions and conditions.
TransactionalMessageVariants - Query transactional message variants and A/B testing data.
ESPSuppressionsByType - Access email suppressions organized by suppression type.

Usage Examples

Query customers by email:

SELECT * FROM Customers WHERE Email = '[email protected]'

Query customer activities by type:

SELECT * FROM Activities WHERE Type = 'sent_email'

Query all campaigns:

SELECT * FROM Campaigns

Query all broadcasts:

SELECT * FROM Broadcasts

Query all segments:

SELECT * FROM Segments

Query all collections:

SELECT * FROM Collections

Query exports by status:

SELECT * FROM Exports WHERE Status = 'done'

Query all transactional messages:

SELECT * FROM TransactionalMessages

Query all workspaces:

SELECT * FROM Workspaces

Query customer attributes for specific customer:

SELECT * FROM CustomerAttributes WHERE CustomerId = '12345'

Query customer messages for specific customer:

SELECT * FROM CustomerMessages WHERE CustomerId = '12345'

Query broadcast messages by type:

SELECT * FROM BroadcastMessages WHERE Type = 'email'

Query all campaign messages:

SELECT * FROM CampaignMessages WHERE CampaignId = 456

Query customer activities by type:

SELECT * FROM CustomerActivities WHERE CustomerId = '12345'

Query all sender identities:

SELECT * FROM SenderIdentities

Query all snippets:

SELECT * FROM Snippets

Query all imports:

SELECT * FROM Imports

Query all subscription topics:

SELECT * FROM SubscriptionTopics

Query customer segments for specific customer:

SELECT * FROM CustomerSegments WHERE CustomerId = '12345'

Query customer subscription preferences:

SELECT * FROM CustomerSubscriptionPreferences WHERE CustomerId = '12345'

Query all ESP suppressions:

SELECT * FROM ESPSuppressions

Query broadcast actions for specific broadcast:

SELECT * FROM BroadcastActions WHERE BroadcastId = 123

Query campaign actions for specific campaign:

SELECT * FROM CampaignActions WHERE CampaignId = 456

Query all broadcast triggers:

SELECT * FROM BroadcastTriggers WHERE BroadcastId = 123

Query all transactional message variants:

SELECT * FROM TransactionalMessageVariants WHERE TransactionalMessageId = 123

Query ESP suppressions by type:

SELECT * FROM ESPSuppressionsByType WHERE SuppressionType = 'bounce'

Connection Properties

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider.

Property	Description
APIKey	Your Customer.io App API Key.
AuthScheme	The scheme used for authentication. Accepted entries are APIKey, or None. Allowed values are: BASIC, NONE, NTLM, OAUTH, APIKEY, OAUTH_CLIENT