Connecting to Omnisend

Omnisend uses token authentication to control access to its service.

Using Token Authentication

To authenticate to Omnisend, you will need to find your API Key. To do so, navigate to https://app.omnisend.com/#/my-account/integrations/api-keys. To connect, set the APIKey to your Omnisend Key in the ProfileSettings connection property.

Example connection string

Profile=C:\profiles\Omnisend.apip;ProfileSettings='ApiKey=your_api_key';

Available Tables

The Omnisend API Profile provides access to the following tables:

Batches: Retrieve a list of batches for your store. List of batches is available for 7 days (requires Endpoint, or BatchId for a single batch).
BatchItems: Retrieve a list of batch items for a given batch id in your store (requires BatchId).
Brands: Retrieve information about the current brand (store).
Campaigns: Retrieve a list of campaigns for your store.
Contacts: Retrieve contacts for your store.
EmailTemplates: Retrieve the email templates saved for your store.
Events: Retrieve the custom and recommended event definitions available for your store.
Images: Retrieve the images uploaded for your store.
ProductCategories: Retrieve product categories for your store.
Products: Retrieve a list of products for your store.
Segments: Retrieve the segments defined for your store.

Usage Examples

Batches:

SELECT * FROM Batches WHERE Endpoint = 'contacts'
SELECT * FROM Batches WHERE BatchId = 'your_batch_id'

BatchItems:

SELECT * FROM BatchItems WHERE BatchId = 'your_batch_id'

Brands:

SELECT * FROM Brands

Campaigns:

SELECT * FROM Campaigns WHERE Status = 'sent'
SELECT * FROM Campaigns WHERE CampaignId = 'your_campaign_id'

Contacts:

SELECT * FROM Contacts WHERE Status = 'subscribed'
SELECT * FROM Contacts WHERE SegmentId = 'your_segment_id'

EmailTemplates:

SELECT * FROM EmailTemplates
SELECT * FROM EmailTemplates WHERE TemplateId = 'your_template_id'

Events:

SELECT * FROM Events WHERE EventNames = 'placed order'

Images:

SELECT * FROM Images

ProductCategories:

SELECT * FROM ProductCategories

Products:

SELECT * FROM Products WHERE Status = 'inStock'

Segments:

SELECT * FROM Segments

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 store API Key.
AuthScheme	The scheme used for authentication. Accepted entries are APIKey or None. Allowed values are: BASIC, NONE, NTLM, OAUTH, APIKEY, OAUTH_CLIENT, OAUTH_PASSWORD