Provides performance metrics for campaigns, including data on opens, clicks, and delivery rates.

Select

You can filter results using the following fields:

• ConversionMetricId: The ID of the metric used for conversion statistics. This is a required filter. If no value is specified, an exception is triggered.
• StartDateTime and EndDateTime: Define the time window for the data. The window must not exceed one year. If no values are specified, the default window is the previous year.

For example:

SELECT * FROM CampaignStats 
WHERE ConversionMetricId = 'conversion-metric-id' 
AND StartDateTime = '2024-07-07' 
AND EndDateTime = '2024-09-09'

You can further filter the results using the following fields:

• SendChannel
• CampaignId
• CampaignMessageId

The allowed filter operators are equals (=) and IN. Only one filter can be applied per attribute. The logical operator AND is the only supported way to combine multiple filters.

Note: A maximum of 100 values can be used with the IN filter.

SendChannel supports the following values:

• email
• sms
• push-notification

For example:

SELECT * FROM CampaignStats 
WHERE ConversionMetricId = 'conversion-metric-id' 
AND StartDateTime = '2024-07-07' 
AND EndDateTime = '2024-09-09' 
AND SendChannel = 'email'

SELECT * FROM CampaignStats 
WHERE ConversionMetricId = 'conversion-metric-id' 
AND SendChannel IN ('email', 'sms') 
AND CampaignId IN ('campaign-id-1', 'campaign-id-2')

Columns