API Data Provider - Online Help

CampaignMonitor Tables

The provider models the data in API as a list of tables in a relational database that can be queried using standard SQL statements.

CampaignMonitor Tables

Name Description
AccountAdministrators list of all (active or invited) administrators associated with a particular account.
AccountClients Returns a list of all the clients in your account, including their name and ID.
AccountPrimaryContact Returns the email address of the administrator who is selected as the primary contact for this account.
BouncedSubscribers Returns a paged result representing all the bounced subscribers for a given list.
CampaignBounces Retrieves a paged result representing all the subscribers who bounced for a given campaign, and the type of bounce (Hard = Hard Bounce, Soft = Soft Bounce).
CampaignClicks Retrieves a paged result representing all subscribers who clicked a link in a given campaign.
CampaignEmailClientUsage Returns the email clients subscribers used to open the campaign.
CampaignLists Returns the lists any campaign was sent to.
CampaignOpens Retrieves a paged result representing all subscribers who opened a given campaign.
CampaignRecipients Retrieves a paged result representing all the subscribers that a given campaign was sent to.
CampaignSegments Returns the segments any campaign was sent to.
CampaignSpams Retrieves a paged result representing all subscribers who marked the given campaign as spam.
CampaignSummary Returns a basic summary of the results for any sent campaign.
CampaignUnsubscribes Retrieves a paged result representing all subscribers who unsubscribed from the email for a given campaign.
ClassicEmailGroupListing Returns a list of classic email groups.
ClientDetails Get the complete details for a client including their API key, access level, contact details and billing settings.
ClientDraftCampaigns Returns a list of all draft campaigns belonging to a client.
ClientEmailSubscriberLists Returns all the subscriber lists across the client, to which an email address is subscribed.
ClientScheduledCampaigns Returns all currently scheduled campaigns for a client.
ClientSegments Returns a list of all list segments belonging to a particular client.
ClientSentCampaigns Returns a list of all sent campaigns for a client.
ClientSubscriberLists Returns all the subscriber lists that belong to a client.
ClientSuppressionList Returns a paged result representing the client's suppression list.
ClientTemplates Returns a list of the templates belonging to a particular client.
DeletedSubscribers Returns a paged result representing all the deleted subscribers for a given list.
JourneyEmailBounces Retrieves a paged result representing all emails that were bounced.
JourneyEmailClicks Retrieves a paged result representing all subscribers who clicked a link in a given journey email.
JourneyEmailOpens Retrieves a paged result representing all subscribers who opened a given journey email.
JourneyEmailRecipients Retrieves a paged result representing all subscribers who have been sent a particular email within a journey.
JourneyEmails Get email list of a journey.
JourneyEmailUnsubscribes Retrieves a paged result representing all subscribers who unsubscribed from a journey email.
Journeys Retrieves a list of all journeys belonging to a particular client.
JourneySummary Get a full summary of a journey.
ListActiveSubscribers Retrieves a paged result representing all the active subscribers for a given list.
ListCustomFields Returns all the custom fields for a given list in your account.
ListDetails Returns a basic summary for each list in your account.
ListSegments Returns all the segments you have created for this list.
ListStats Returns a comprehensive summary statistics for each list in your account.
SegmentActiveSubscribers Returns all of the active subscribers that match the rules for a specific segment
SegmentDetails Returns the name, list ID, segment ID and number of active subscribers within an existing segment as well as the current rules for that segment.
SmartEmailDetails Returns the details for a smart transactional email.
SmartEmailListing Returns a list of smart transactional emails.
SubscriberDetails Retrieves a subscriber's details.
SubscriberHistory Retrieves a historical record of campaigns and automated workflow emails received by a subscriber.
TemplateDetails Returns all the basic details for a specific template.
TransactionalMessageDetails Returns the message details, no matter how it was sent, including status.
TransactionalMessageTimeline Returns a list of sent messages (classic or smart).
TransactionalStatistics Returns delivery and engagement statistics, optionally filter by smart email or classic group.
UnconfirmedSubscribers Contains a paged result representing all the unconfirmed subscribers (those who have subscribed to a confirmed-opt-in list, but have not confirmed their subscription) for a given list.
UnsubscribedSubscribers Returns a paged result representing all the unsubscribed subscribers for a given list.
Webhooks Returns all the webhooks you have created for a given list.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 23.0.8839.0