API Data Provider - Online Help

SendPulse 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.

SendPulse Tables

Name Description
AutomationFlowsStatistics Retrieve statistics a specific automation flow. You can get the flow id (autoresponder id) from the flow's URL when viewing it.
BouncesDay Retrieve information about bounces for a 24-hour period.
Campaigns Retrieve a list of campaigns.
ConvertedContacts Retrieve a list of the subscribers who converted via either method. You can get the flow id (autoresponder id) from the flow's URL when viewing it.
EmailStatistics Retrieve statistics for an email address and campaigns it is in.
FacebookBotChats Retrieve a list of chats with subscribers with information about the contact and the last message received from the contact.
FacebookBotContactsByTag Search for contacts by tag in the specified bot.
FacebookBotFlows Retrieve a list of created flows for the selected bot and information for each.
FacebookBotMessages Retrieve a list of all messages in correspondence with the specified subscriber.
FacebookBotTriggers Retrieve the list of created triggers for the selected bot with information about each of them.
FacebookBotVariables Retrieve a list of variables for the selected bot with information about each.
FacebookChatbotsAccount Retrieve Facebook chatbots account information.
FacebookConnectedBots Retrieve lists of bots with information about each.
FlowConversions Retrieve information about the amount of executed conversions and amount of conversions of each type in the flow. You can get the flow id (autoresponder id) from the flow's URL when viewing it.
FlowStatistics Retrieve statistic about each element in the flow. You can get the flow id (autoresponder id) from the flow's URL when viewing it.
MailingListEmails Retrieve a list of emails from a Mailing List
MailingLists Retrieve
Senders Retrieve a list of senders.
SentEmails Retrieve a list of all sent emails.
SentWebPushCampaigns Retrieve a list of sent web push campaigns.
SentWebPushCampaignStatistics Retrieve statistics on sent campaigns.
SmsBlacklist Retrieve sms blacklist.
SmsCampaigns Retrieve a list of sms campaigns.
TelegramAccount Retrieve information about your current account pricing plan, the number of messages in your plan, bots, contacts, list of tags, and variables.
TelegramBotChats Retrieve a list of chats with subscribers with information about the contact and the last message received from the contact.
TelegramBotContactsByTag Search for contacts by tag in the specified bot.
TelegramBotFlows Retrieve a list of created flows for the selected bot and information for each.
TelegramBotMessages Retrieve a list of all messages in correspondence with the specified subscriber.
TelegramBotTriggers Retrieve the list of created triggers for the selected bot with information about each of them.
TelegramBotVariables Retrieve a list of variables for the selected bot with information about each.
TelegramConnectedBots Retrieve lists of bots with information about each.
Templates Retrieve a list of templates.
UnsubscribedUsers Retrieve a list of unsubscribed users. If you enter a specific Day, the data will be for 1 day.
VkBotChats Retrieve a list of chats with subscribers with information about the contact and the last message received from the contact.
VkBotContactsByTag Search for contacts by tag in the specified bot.
VkBotFlows Retrieve a list of created flows for the selected bot and information for each.
VkBotMessages Retrieve a list of all messages in correspondence with the specified subscriber.
VkBotTriggers Retrieve the list of created triggers for the selected bot with information about each of them.
VkBotVariables Retrieve a list of variables for the selected bot with information about each.
VkChatbotsAccount Retrieve Vkontakte chatbots account information.
VkConnectedBots Retrieve lists of bots with information about each.
Webhooks Retrieve a list of webhooks.
Websites Retrieve a list of websites.
WebsiteSubscribers Retrieve a list subscribers for a certain website.

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