API Data Provider - Online Help

Connecting to Cleverpush

CleverPush uses private API keys to authenticate requests. Your API key is passed as the Authorization request header value on every API call.

Using API Key Authentication

You can find your private API key in the CleverPush dashboard under Settings > API. Use the private key (not the public key) for server-side access.

After setting the following connection properties, you are ready to connect:

  • AuthScheme: Set this to APIKey.
  • APIKey: Set this to your CleverPush private API key.

Example connection string

Profile=C:\profiles\Cleverpush.apip;ProfileSettings="APIKey=my_api_key";

Optional Connection Properties

  • ChannelId: Set this to your default CleverPush channel identifier. Most tables require a channel filter. Setting this property allows queries without specifying ChannelId in every WHERE clause.

Available Tables

The CleverPush API Profile provides access to push notification platform data across 30 tables:

  • Channels - Query CleverPush channel configurations and settings; retrieve a single channel by Id.
  • Projects - Access project records associated with your CleverPush account.
  • ChannelStatistics - Query subscription statistics for a channel over a given period. Requires ChannelId and StartDate.
  • ChannelSubscriptions - Query push notification subscriptions for a channel. Requires ChannelId.
  • Subscription - Look up a single subscription by ID, attribute, or email address.
  • Notifications - Query push notifications sent on a channel; retrieve a single notification by Id. Requires ChannelId.
  • NotificationEvents - Access cursor-paginated delivery events for a specific notification. Requires ChannelId and NotificationId.
  • NotificationHourlyStatistics - Query hourly send and click statistics for a notification. Requires ChannelId and NotificationId.
  • Segments - Access subscriber segments defined for a channel. Requires ChannelId.
  • SegmentStatistics - Query daily subscription statistics for a segment. Requires ChannelId and SegmentId.
  • Tags - Query subscriber tags for a channel; retrieve a single tag by Id. Requires ChannelId.
  • TagStatistics - Access daily subscription statistics for a tag. Requires ChannelId and TagId.
  • Topics - Query notification topics defined for a channel. Requires ChannelId.
  • TopicStatistics - Access daily subscription statistics for a topic. Requires ChannelId and TopicId.
  • Conversations - Query subscriber conversations for a channel. Requires ChannelId.
  • ConversationMessages - Access messages within a conversation. Requires ChannelId and ConversationId.
  • EmailAccounts - Query email account configurations associated with your CleverPush account.
  • SmsProviders - Access SMS provider configurations for your CleverPush account.
  • NotificationGroups - Query notification groups for a channel. Requires ChannelId.
  • NotificationTemplates - Access saved notification templates for a channel. Requires ChannelId.
  • AppBanners - Query in-app banner campaigns for a channel; retrieve a single banner by Id. Requires ChannelId.
  • FollowUpCampaigns - Access follow-up notification campaigns for a channel; retrieve a single campaign by Id. Requires ChannelId.
  • GeoFences - Query geographic fence definitions for a channel; retrieve a single geo fence by Id. Requires ChannelId.
  • Stories - Access story definitions for a channel; retrieve a single story by Id. Requires ChannelId.
  • ChannelEvents - Query conversion event definitions for a channel. Requires ChannelId.
  • TagGroups - Query tag groups for a channel. Requires ChannelId.
  • NotificationCampaigns - Query notification campaigns for a channel; retrieve a single campaign by Id. Requires ChannelId.
  • DeepLinks - Query deep link configurations for a channel; retrieve a single deep link by Id. Requires ChannelId.
  • EmailOptInForms - Query email opt-in forms for a channel. Requires ChannelId.
  • EmailOptInRoutines - Query email opt-in routines for a channel. Requires ChannelId.

Usage Examples

AppBanners: 

SELECT * FROM AppBanners WHERE ChannelId = 'channel123'

ChannelEvents: 

SELECT * FROM ChannelEvents WHERE ChannelId = 'channel123'

ChannelStatistics: 

SELECT * FROM ChannelStatistics WHERE ChannelId = 'channel123'

ChannelSubscriptions: 

SELECT * FROM ChannelSubscriptions WHERE ChannelId = 'channel123'

Channels: 

SELECT * FROM Channels

ConversationMessages: 

SELECT * FROM ConversationMessages WHERE ChannelId = 'channel123' AND ConversationId = 'conversation123'

Conversations: 

SELECT * FROM Conversations WHERE ChannelId = 'channel123'

DeepLinks: 

SELECT * FROM DeepLinks WHERE ChannelId = 'channel123'

EmailAccounts: 

SELECT * FROM EmailAccounts

EmailOptInForms: 

SELECT * FROM EmailOptInForms WHERE ChannelId = 'channel123'

EmailOptInRoutines: 

SELECT * FROM EmailOptInRoutines WHERE ChannelId = 'channel123'

FollowUpCampaigns: 

SELECT * FROM FollowUpCampaigns WHERE ChannelId = 'channel123'

GeoFences: 

SELECT * FROM GeoFences WHERE ChannelId = 'channel123'

NotificationCampaigns: 

SELECT * FROM NotificationCampaigns WHERE ChannelId = 'channel123'

NotificationEvents: 

SELECT * FROM NotificationEvents WHERE ChannelId = 'channel123' AND NotificationId = 'notification123'

NotificationGroups: 

SELECT * FROM NotificationGroups WHERE ChannelId = 'channel123'

NotificationHourlyStatistics: 

SELECT * FROM NotificationHourlyStatistics WHERE ChannelId = 'channel123' AND NotificationId = 'notification123'

Notifications: 

SELECT * FROM Notifications WHERE ChannelId = 'channel123'

NotificationTemplates: 

SELECT * FROM NotificationTemplates WHERE ChannelId = 'channel123'

Projects: 

SELECT * FROM Projects

Segments: 

SELECT * FROM Segments WHERE ChannelId = 'channel123'

SegmentStatistics: 

SELECT * FROM SegmentStatistics WHERE ChannelId = 'channel123' AND SegmentId = 'segment123'

SmsProviders: 

SELECT * FROM SmsProviders

Stories: 

SELECT * FROM Stories WHERE ChannelId = 'channel123'

Subscription: 

SELECT * FROM Subscription

TagGroups: 

SELECT * FROM TagGroups WHERE ChannelId = 'channel123'

Tags: 

SELECT * FROM Tags WHERE ChannelId = 'channel123'

TagStatistics: 

SELECT * FROM TagStatistics WHERE ChannelId = 'channel123' AND TagId = 'tag123'

Topics: 

SELECT * FROM Topics WHERE ChannelId = 'channel123'

TopicStatistics: 

SELECT * FROM TopicStatistics WHERE ChannelId = 'channel123' AND TopicId = 'topic123'

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

Copyright (c) 2026 CData Software, Inc. - All rights reserved.
Build 26.0.9770.0