API Data Provider - Online Help

EmailOctopus Tables

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

Generally, querying API tables is the same as querying a table in a relational database. Sometimes there are special cases, for example, including a certain column in the WHERE clause might be required to get data for certain columns in the table. This is typically needed for situations where a separate request must be made for each row to get certain columns. These types of situations are clearly documented at the top of the table page linked below.

EmailOctopus Tables

Name Description
CampaignReportBounced Get information on the contacts who the campaign was sent to but bounced.
CampaignReportClicked Get information on the contacts who clicked a link in the campaign.
CampaignReportComplained Get information on the contacts who complained about the campaign.
CampaignReportNotClicked Get information on the contacts who didn't click a link in the campaign.
CampaignReportNotOpened Get information on the contacts who didn't open the campaign.
CampaignReportOpened Get information on the contacts who opened the campaign.
CampaignReportSent Get information on the contacts who the campaign was sent to.
CampaignReportSummary Get a summary of the campaign.
CampaignReportUnsubscribed Get information on the contacts who unsubscribed using a link in the campaign.
Campaigns Get details of all campaigns.
ListContacts Get details of all contacts of a list.
Lists Get details of all lists.
ListSubscribedContacts Get details of all subscribed contacts of a list.
ListUnsubscribedContacts Get details of all unsubscribed contacts of a list.

Copyright (c) 2023 CData Software, Inc. - All rights reserved.
Build 22.0.8487.0