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// 1. Create the request object
2RetrieveRequest request = new RetrieveRequest();
3request.ObjectType = "EmailSendDefinition";
4SimpleFilterPart idFilter = new SimpleFilterPart();
5
6// create the simple filter.
7idFilter.Property = "CustomerKey";
8idFilter.SimpleOperator = SimpleOperators.equals;
9idFilter.Value = new string[] { "228" };
10request.Filter = idFilter; // comment out this line to get all EmailSendDefinitions
11// EmailSendDefinition supports SendDefinition list property in Retrieve calls.
12request.Properties = new string[]  { "Name","Description","Email.ID","SendDefinitionList" // This is the new property };
13// Invoke the Web Service
14APIObject[] results;
15proxy = ExactTarget.Integration.Helper.GetInterfaceProxy(mobjETPrincipal);
16string status = proxy.Retrieve(request, ref requestID, out results);
17// Print out overall results
18System.Text.StringBuilder sb = new System.Text.StringBuilder();
19sb.Append("Retrieve Send");
20sb.AppendFormat("\nOverall result: {0}.  RequestID: {1}", status, requestID);
21Console.WriteLine(sb.ToString());
22// Print out results for each new object created
23for (int cntr = 0; cntr < results.Length; cntr++)
24{
25sb.Append(string.Format("\nIndex {0}", cntr));
26EmailSendDefinition ESD= results[cntr] as EmailSendDefinition;
27sb.Append("\n ID: " + ESD.Name);
28sb.Append("\n Name: " + ESD.Description);
29sb.Append("\n EmailID: " + ESD.Email.ID);
30// Get SendDefinitionLists for each EmailSendDefinition
31foreach (SendDefinitionList SDL in ESD.SendDefinitionList)
32{         sb.Append("\n SendDefinitionListType ID: " + SDL.SendDefinitionListType);
33    sb.Append("\n SendDefinitionList ID: " + SDL.List.ID);
34}
35sb.Append("\n");
36}
37Console.WriteLine(sb.ToString());