Customer Execution Details By Campaign

Returns an array of all customer IDs and the details associated with each customer for a particular campaign ID.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

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

  • If supplied, CustomerAttributes must contain one or more valid attribute names (see GetCustomerAttributeList) separated by semicolons (;). The values are returned in the same order as the attribute names specified in the request.
  • The customer attribute values returned are the current (latest available) values, not those on the campaign date.
  • If the optional request parameter IncludeControlGroup is set to True, the results returned will include the customer IDs of customers who were included in the campaign's control group (i.e., those customers included in the campaign's target group but who did not actually receive the campaign). When included, these customers are identified in the response by an ActionID of 1, ChannelID of 100, and TemplateID of -1.
  • All times are returned in UTC.
  • Channel ID must be provided while calling this function upon receiving an event type 13 notification.

Sample Request

https://apiX.optimove.net/current/customers/GetCustomerExecutionDetailsByCampaign?CampaignID=836&CustomerAttributes=Alias;Country&IncludeControlGroup=True

Sample Response

[
  {"CustomerID":"A1342","ActionID":14,"ChannelID":15,"TemplateID":"60","ScheduleTime":"2018-09-01 10:00:00",
   	"PromoCode":"FreeShip50","CustomerAttributes":["RhondaP","UK"]},
  {"CustomerID":"A9258","ActionID":14,"ChannelID":15,"TemplateID":"60","ScheduleTime":"2018-09-01 10:00:00",
   	"PromoCode":"FreeShip50","CustomerAttributes":["JacquesR","FR"]}
]
Query Params
int32
required
int32
Defaults to 0

The identifier of a particular campaign execution channel.

boolean
Defaults to false
boolean
Defaults to false

Should the response include the template names and not only the Template IDs.

Response

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json