Retrieve All Links for a Send

This page contains information about retrieving all links for a send.

Why Retrieve All Links for a Send

By retrieving all links for a send, you can see which links are included in your email and how your subscribers have interacted with those links. For example, you can retrieve information relating to clicks on a specific link, allowing you to take action related to those click numbers.

How To Retrieve All Links for a Send

Use the sample code below as an example to construct your own API calls.

Sample .NET Code

1// Filter by SendID SimpleFilterPart listSendFilter = new SimpleFilterPart();
2listSendFilter.Property = "SendID";
3listSendFilter.SimpleOperator = SimpleOperators.equals;
4listSendFilter.Value = new string[] { "2057" };
5// Create the RetrieveRequest
6RetrieveRequest request = new RetrieveRequest();
7request.ObjectType = "LinkSend";
8request.Filter = listSendFilter;
9request.Properties = new string[] { "ID", "SendID", "Client.ID", "Client.PartnerClientKey", "Link.ID", "Link.TotalClicks", "Link.UniqueClicks", "Link.URL", "Link.Alias" };
10// Execute the Retrieve
11APIObject[] results;
12string status = integrationFramework.Retrieve(request, out requestID, out results);
13// Output the results
14System.Text.StringBuilder sb = new System.Text.StringBuilder();
15sb.Append("Link Send Summary");
16sb.AppendFormat("\nOverall result: {0}.  RequestID: {1}", status, requestID);
17// Print out results for each new object created
18for (int cntr = 0; cntr < results.Length; cntr++)
19{
20       sb.Append(string.Format("\n ---- Index {0}", cntr));
21       LinkSend id = results[cntr] as LinkSend;
22       sb.Append("\n SendID: " + id.SendID);
23       sb.Append("\n Link.ID: " + id.Link.ID);
24       sb.Append("\n Link.TotalClicks: " + id.Link.TotalClicks);
25       sb.Append("\n Link.UniqueClicks: " + id.Link.UniqueClicks);
26       sb.Append("\n Link.URL: " + id.Link.URL);
27       sb.Append("\n Link.Alias: " + id.Link.Alias);
28       sb.Append("\n");
29}
30Console.WriteLine(sb.ToString());

Output

1Link Send Summary Overall result: OK.
2RequestID: 0dc6c6a8-dc74-4c69-a3de-48297304fd0e ---- Index 0
3SendID: 2057
4Link.ID: 5658
5Link.TotalClicks: 2
6Link.UniqueClicks: 1
7Link.URL: http://click.preview.exacttarget.com/unsub_center.aspx
8Link.Alias: Unsubscribe