Retrieve Audience of Send Definition

This page contains sample code illustrating how to retrieve the audience of an email send definition using the SOAP API.

Why Retrieve the Audience of a Email Send Definition

You can view all subscribers to whom an email send definition was targeted by retrieving the audience of a send definition.

How To Retrieve the Audience of an Email Send Definition

Use the sample code below as an example to create your own API call.

Sample .NET Code

// 1. Create the request object
RetrieveRequest request = new RetrieveRequest();
request.ObjectType = "EmailSendDefinition";
SimpleFilterPart idFilter = new SimpleFilterPart();

// create the simple filter.
idFilter.Property = "CustomerKey";
idFilter.SimpleOperator = SimpleOperators.equals;
idFilter.Value = new string[] { "228" };
request.Filter = idFilter; // comment out this line to get all EmailSendDefinitions
// EmailSendDefinition supports SendDefinition list property in Retrieve calls.
request.Properties = new string[]  { "Name","Description","Email.ID","SendDefinitionList" // This is the new property };
// Invoke the Web Service
APIObject[] results;
proxy = ExactTarget.Integration.Helper.GetInterfaceProxy(mobjETPrincipal);
string status = proxy.Retrieve(request, ref requestID, out results);
// Print out overall results
System.Text.StringBuilder sb = new System.Text.StringBuilder();
sb.Append("Retrieve Send");
sb.AppendFormat("\nOverall result: {0}.  RequestID: {1}", status, requestID);
Console.WriteLine(sb.ToString());
// Print out results for each new object created
for (int cntr = 0; cntr < results.Length; cntr++)
{
sb.Append(string.Format("\nIndex {0}", cntr));
EmailSendDefinition ESD= results[cntr] as EmailSendDefinition;
sb.Append("\n ID: " + ESD.Name);
sb.Append("\n Name: " + ESD.Description);
sb.Append("\n EmailID: " + ESD.Email.ID);
// Get SendDefinitionLists for each EmailSendDefinition
foreach (SendDefinitionList SDL in ESD.SendDefinitionList)
{         sb.Append("\n SendDefinitionListType ID: " + SDL.SendDefinitionListType);
    sb.Append("\n SendDefinitionList ID: " + SDL.List.ID);
}
sb.Append("\n");
}
Console.WriteLine(sb.ToString());