List campaign social bookmark views

The ListCampaignSocialBookmarkViews method retrieves a list of social bookmark views generated by a campaign.

Guidance Notes

This will only track social book mark views generated by the in-application Add social bookmark links tool.

You may request up to 1000 records at a time. To iterate through the whole data set you should use the select and skip parameters. For example to select the first 1000 records in the data set you should set the select parameter to 1000 and the skip parameter to 0. To select the next 1000 records you should set the select parameter to 1000 and the skip parameter to 1000. You should continue to do this until 0 records are returned to you to get the whole data set.

Parameters

username	string	This is the username from your API key. It is in the format of an email address and will look similar to apiuser‑908709770324@apiconnector.com	required
password	string	This is the password from your API key.	required
campaignId	int	This is the ID of the campaign you wish to query against.	required
select	int	This is a number which indicates the number of records you wish to select. This argument must no greater than 1000	required
skip	int	This is a number which is the number of records you want to skip; to select all records from 1001 to 2000: set this number to 1000.	required

Return values

The result is an array of APICampaignSocialBookmark objects, each consisting of the following:

contactId	string	The ID of the contact sent the campaign through which the page view was generated.
name	string	The name of the social network.
numViews	int	The number of tracked social bookmark views.

Error responses

ERROR_CAMPAIGN_INVALID
ERROR_CAMPAIGN_NOT_FOUND
ERROR_APIUSAGE_EXCEEDED
ERROR_INVALID_LOGIN
ERROR_PARAMETER_INVALID
ERROR_SYSTEM_SERVICETEMPORARILYUNAVAILABLE
ERROR_UNKNOWN

Request

POST /API.asmx HTTP/1.1
Host: apiconnector.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://apiconnector.com/ListCampaignSocialBookmarkViews"

Example of use in C# .NET

public void ListCampaignSocialBookmarkViews()
{
   const string userName = "apiuser-xxxxxxxxxxxx@apiconnector.com";
   const string password = "xxxxxxxxxxx";
   const int campaignId = 1234567;
   try
   {
       int currentPage = 0;   // what page are we on
       const int itemsPerPage = 5;  // the number of bookMarks we want to be returned for each page
       com.apiconnector.API api = new com.apiconnector.API();

       APICampaignSocialBookmark[] bookMarks = api.ListCampaignSocialBookmarkViews(userName, password,
                                                                                   campaignId, itemsPerPage,
                                                                                   currentPage*itemsPerPage);
       // keep getting displaying and getting more bookMarks until we have no more
       while (bookMarks != null && bookMarks.Length > 0)
       {
           // output the current page
           Console.WriteLine("CurrentPage: {0}", currentPage + 1);
           foreach (APICampaignSocialBookmark mark in bookMarks)
           {
               Console.WriteLine("ContactId: {0}", mark.ContactId);
               Console.WriteLine("Name: {0}", mark.Name);
               Console.WriteLine("NumViews: {0}", mark.NumViews);
           }

           // write out blank line, so the output is easier to read
           Console.WriteLine();
           // increment the page
           currentPage++;
           // execute the next get - see above
           bookMarks = api.ListCampaignSocialBookmarkViews(userName, password, campaignId, itemsPerPage,
                                                           currentPage*itemsPerPage);
       }
       // output some stats
       Console.WriteLine("Total Pages {0}, {1} per page", currentPage, itemsPerPage);
       Console.WriteLine();
   }
   catch (Exception e)
   {
       Console.WriteLine(e.ToString());
   }
}

Example of use in VB.NET

Public Sub ListCampaignSocialBookmarkViews()
               Const  userName As String = "apiuser-xxxxxxxxxxxx@apiconnector.com"
               Const  password As String = "xxxxxxxxxxx"
               Const  campaignId As Integer = 1234567
               Try
                               Dim currentPage As Integer = 0
                               ' what page are we on
                               Const  itemsPerPage As Integer = 5
                               ' the number of bookMarks we want to be returned for each page
                               Dim api As New com.apiconnector.API()

                               Dim bookMarks As APICampaignSocialBookmark() = api.ListCampaignSocialBookmarkViews(userName, password, campaignId, itemsPerPage, currentPage * itemsPerPage)
                               ' keep getting displaying and getting more bookMarks until we have no more
                               While bookMarks IsNot Nothing AndAlso bookMarks.Length > 0
                                               ' output the current page
                                               Console.WriteLine("CurrentPage: {0}", currentPage + 1)
                                               For Each mark As APICampaignSocialBookmark In bookMarks
                                                               Console.WriteLine("ContactId: {0}", mark.ContactId)
                                                               Console.WriteLine("Name: {0}", mark.Name)
                                                               Console.WriteLine("NumViews: {0}", mark.NumViews)
                                               Next

                                               ' write out blank line, so the output is easier to read
                                               Console.WriteLine()
                                               ' increment the page
                                               currentPage += 1
                                               ' execute the next get - see above
                                               bookMarks = api.ListCampaignSocialBookmarkViews(userName, password, campaignId, itemsPerPage, currentPage * itemsPerPage)
                               End While
                               ' output some stats
                               Console.WriteLine("Total Pages {0}, {1} per page", currentPage, itemsPerPage)
                               Console.WriteLine()
               Catch e As Exception
                               Console.WriteLine(e.ToString())
               End Try
End Sub

Sample request

POST /API.asmx HTTP/1.1
Host: api.nightly.dotmailer-internal
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://apiconnector.com/ListCampaignSocialBookmarkViews"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <ListCampaignSocialBookmarkViews xmlns="http://apiconnector.com">
      <username>string</username>
      <password>string</password>
      <campaignId>int</campaignId>
      <select>int</select>
      <skip>int</skip>
    </ListCampaignSocialBookmarkViews>
  </soap:Body>
</soap:Envelope>

Sample response

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <ListCampaignSocialBookmarkViewsResponse xmlns="http://apiconnector.com">
      <ListCampaignSocialBookmarkViewsResult>
        <APICampaignSocialBookmark>
          <ContactId>int</ContactId>
          <Name>string</Name>
          <NumViews>int</NumViews>
        </APICampaignSocialBookmark>
        <APICampaignSocialBookmark>
          <ContactId>int</ContactId>
          <Name>string</Name>
          <NumViews>int</NumViews>
        </APICampaignSocialBookmark>
      </ListCampaignSocialBookmarkViewsResult>
    </ListCampaignSocialBookmarkViewsResponse>
  </soap:Body>
</soap:Envelope>

About the API

Address books

Contacts

Campaigns

Reporting

SMS

Account

Images

Documents

Templates