Returns the details of a particular customer’s interactions with campaigns sent during a particular date range.
Important Update: GetCustomerChannelInteractions Endpoint
GetCustomerChannelInteractions EndpointWe have released a new and improved endpoint for retrieving campaign metrics: GetCampaignEngagementMetrics.
This new endpoint expands on the functionality of the older GetCustomerChannelInteractions endpoint by providing metrics for both scheduled and triggered campaigns.
What This Means For You
You have two options to take advantage of these new capabilities:
Option 1 (Recommended): Migrate to the New Endpoint
This is the best long-term solution. To ensure you receive all future updates and improvements, we recommend updating your applications to use the new endpoint.
- New Endpoint:
GetCampaignEngagementMetrics
Action Required: Update any code that currently calls GetCustomerChannelInteractions to call GetCampaignEngagementMetrics instead.
Option 2: Enable Compatibility Mode for the Old Endpoint
If you cannot immediately update your code, you can continue using the existing GetCustomerChannelInteractions endpoint. To receive the new, richer data, you must ask us to enable a feature flag for your account.
How it works:
- If the flag is OFF: The
GetCustomerChannelInteractionsendpoint will continue to function exactly as it does today. - If the flag is ON: The endpoint will return the new, improved response format, which is identical to the response from
GetCampaignEngagementMetrics.
Rate Limit
This endpoint is subject to the general API rate limit of 50 requests per 10 seconds. Learn more about handling rate limits.
Notes
- Available ChannelID values can be seen here.
Sample Request
Sample Response
[
{"Date":"2018-08-20","CampaignID":422,"RecipientGroupID":1,"ActionID":26,"ChannelID":7,
"TemplateID":13,"EventID":2},
{"Date":"2018-08-27","CampaignID":428,"RecipientGroupID":1,"ActionID":28,"ChannelID":7,
"TemplateID":54,"EventID":2}
]