Connecting to ActiveTrail

Using API Key Authentication

ActiveTrail uses API key authentication. To obtain an API key:

Log in to your ActiveTrail account at https://app.activetrail.com
Navigate to your account settings and locate the API integration section
Generate or copy your existing API key

After obtaining your API key, set the following connection properties:

AuthScheme: Set this to APIKey.
APIKey: Set this to your ActiveTrail API key.

Example Connection String

Profile=C:\profiles\ActiveTrail.apip;AuthScheme=APIKey;APIKey=your_api_key;

Connecting to ActiveTrail

Once the authentication is configured, you can connect to ActiveTrail and query data from any of the available tables such as Contacts, Groups, Campaigns, CampaignReports, Automations, and SmsCampaigns.

Available Tables

The ActiveTrail API Profile provides access to the following tables:

AccountBalance: Retrieve current email/SMS credit balance and coupon alert status for the account
AutomationTriggerTypes: Retrieve the catalog of automation trigger types available
Automations: Retrieve automation workflows in the account
CampaignDetails: Retrieve the full configuration (campaign details, content, and design) for a specific email campaign (requires Id)
CampaignReportBounces: Retrieve contacts whose email bounced for a specific campaign (requires CampaignId)
CampaignReportClickDetails: Retrieve per-link click statistics for a specific campaign (requires CampaignId)
CampaignReportOpens: Retrieve contacts who opened a specific campaign (requires CampaignId)
CampaignReportSent: Retrieve recipients who were sent a specific campaign (requires CampaignId)
CampaignReportUnsubscribed: Retrieve contacts who unsubscribed from a specific campaign (requires CampaignId)
CampaignReports: Retrieve aggregated statistics for email campaigns
Campaigns: Retrieve email campaigns in the account
ContactActivity: Retrieve campaign engagement history for a specific contact (requires ContactId)
ContactErrors: Retrieve bounce and delivery error records for a specific contact (requires ContactId)
ContactGroups: Retrieve groups that a specific contact belongs to (requires ContactId)
ContactMailingLists: Retrieve mailing lists that a specific contact belongs to (requires ContactId)
Contacts: Retrieve contacts in the account
ContentCategories: Retrieve content categories used to classify campaign templates
GroupMembers: Retrieve members of a specific group (requires GroupId)
Groups: Retrieve contact groups defined in the account
MailingListMembers: Retrieve members of a specific mailing list (requires MailingListId)
MailingLists: Retrieve all mailing lists in the account
PushCampaignReports: Retrieve aggregated statistics for push notification campaigns
PushCampaigns: Retrieve push-notification campaigns in the account
SegmentationRuleTypes: Retrieve the catalog of segmentation rule type names
Segmentations: Retrieve user-defined segmentations in the account
SendingProfiles: Retrieve email sending profiles configured in the account
SentCampaigns: Retrieve campaigns that have already been sent
SignupForms: Retrieve signup forms defined in the account
SmsCampaignReportClickers: Retrieve contacts who clicked a link in a specific SMS campaign (requires CampaignId)
SmsCampaignReportDelivered: Retrieve recipients whose SMS was delivered (requires CampaignId)
SmsCampaignReportSent: Retrieve recipients who were sent a specific SMS campaign (requires CampaignId)
SmsCampaigns: Retrieve SMS campaigns in the account
SmsUnsubscribers: Retrieve contacts who have opted out of SMS communications
SubscriptionAllContacts: Retrieve subscription status changes for all contacts
SubscriptionSubscribers: Retrieve the list of currently subscribed contacts
SubscriptionUnsubscribers: Retrieve the list of unsubscribed contacts
TemplateCategories: Retrieve template categories defined in the account
Templates: Retrieve email templates available in the account

Important Notes

The Authorization header for ActiveTrail is the API key value itself - do NOT prefix it with "Bearer".
ActiveTrail uses page-based pagination via the Page and Limit query parameters; default Limit is 20, maximum is 100.
Campaigns, SubscriptionAllContacts, SubscriptionSubscribers, and SubscriptionUnsubscribers require lowercase page and limit query parameters and a maximum limit of 50; uppercase Page/Limit or a limit of 100 returns a 400/500 error on these endpoints.
Time-filtered endpoints default to a 3-month lookback unless FromDate / ToDate are specified.
Several child tables require a parent identifier (e.g. ContactId, GroupId, CampaignId) to be specified as a filter.
Date fields use ISO 8601 format.
Trial accounts return empty arrays for many entities until data is created.

API Documentation

For more information about the ActiveTrail API, see the official ActiveTrail API documentation.

Usage Examples

Contacts:

SELECT * FROM Contacts

Groups:

SELECT * FROM Groups

GroupMembers:

SELECT * FROM GroupMembers WHERE GroupId = '356069'

MailingLists:

SELECT * FROM MailingLists

Campaigns:

SELECT * FROM Campaigns

Campaigns by status:

SELECT * FROM Campaigns WHERE FilterType = 'Sent'

SentCampaigns:

SELECT * FROM SentCampaigns

CampaignDetails:

SELECT * FROM CampaignDetails WHERE Id = '12345'

CampaignReports:

SELECT * FROM CampaignReports

CampaignReportOpens:

SELECT * FROM CampaignReportOpens WHERE CampaignId = '12345'

CampaignReportClickDetails:

SELECT * FROM CampaignReportClickDetails WHERE CampaignId = '12345'

CampaignReportBounces:

SELECT * FROM CampaignReportBounces WHERE CampaignId = '12345'

Templates:

SELECT * FROM Templates

Automations:

SELECT * FROM Automations

SmsCampaigns:

SELECT * FROM SmsCampaigns

PushCampaigns:

SELECT * FROM PushCampaigns

ContactActivity:

SELECT * FROM ContactActivity WHERE ContactId = '263310292'

ContactGroups:

SELECT * FROM ContactGroups WHERE ContactId = '263310292'

SubscriptionAllContacts:

SELECT * FROM SubscriptionAllContacts

SubscriptionSubscribers:

SELECT * FROM SubscriptionSubscribers

SubscriptionUnsubscribers:

SELECT * FROM SubscriptionUnsubscribers

Segmentations:

SELECT * FROM Segmentations

SignupForms:

SELECT * FROM SignupForms

SendingProfiles:

SELECT * FROM SendingProfiles

ContentCategories:

SELECT * FROM ContentCategories

AccountBalance:

SELECT * FROM AccountBalance

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