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.

<script runat="server">

  Platform.Load("Core", "1");

  // Set up the Retrieve Request

  var requestID;

  var status;

  var filter = {

    Property: "SendID",

    SimpleOperator: "equals",

    Value: ["724500"]

  };

  // Define the properties you want to retrieve

  var properties = ["ID", "SendID", "Client.ID", "Client.PartnerClientKey", "Link.ID", "Link.TotalClicks", "Link.UniqueClicks", "Link.URL", "Link.Alias"];

  // Execute the Retrieve Request

  try {

    var results = Retrieve("LinkSend", properties, filter);

    // Output the results

    var sb = [];

    sb.push("Link Send Summary<br/>");

    sb.push("Overall result: Success. RequestID: " + requestID+'<br/>');

    for (var i = 0; i < results.length; i++) {

      var result = results[i];

      sb.push("<br/> ---- Index " + i);

      sb.push("SendID: " + result.SendID+'<br/>');

      sb.push("Link.ID: " + result.Link.ID+'<br/>');

      sb.push("Link.TotalClicks: " + result.Link.TotalClicks+'<br/>');

      sb.push("Link.UniqueClicks: " + result.Link.UniqueClicks+'<br/>');

      sb.push("Link.URL: " + result.Link.URL+'<br/>');

      sb.push("Link.Alias: " + result.Link.Alias+'<br/>');

      sb.push("<br/>");

    }

    Write(sb.join("<br/>"));

  } catch (e) {

    Write("Error: " + e.message);

  }

  // Retrieve function

  function Retrieve(objectType, properties, filter) {

    var wsProxy = new Script.Util.WSProxy();

    var request = {

      ObjectType: objectType,

      Properties: properties,

      Filter: filter

    };

    var response = wsProxy.retrieve(objectType, properties, filter);

    requestID = response.RequestID;

    return response.Results;

  }

</script>