SpreadWebServcie.GetCampaignUnsubscribes Method

The following examples demonstrate how to get campaign unsubscribe detail.

Parameters

Parameter

Type

Description

loginEmail

String

The login email of your Spread account.

password

String

The password of your Spread account or API Key which you can retrieve from your Spread account (My account=> Settings).

campaignId

String

The ID of the email campaign.

startDate

DateTime

The starting time of report.

endDate

DateTime

The ending time of report.

Return Value

Dataset containing a single table with columns subscriber_email and date

Example

Dim loginName As String = "Spread@reasonables.com"
Dim loginPassword As String = "Spread"

Dim campaignID As Integer = 123456
// suggest dateTime string format "yyyy-MM-ddTHH:mm:ss" ,such as "2023-02-06T12:11:21" .
Dim startTime As DateTime = "2023-02-06T12:11:21"
Dim endTime As DateTime = "2023-02-06T12:11:21"

'Create a SpreadWebService object and use its method.
Dim MySpread As New SpreadWebService
Dim result As DataSet = MySpread.GetCampaignUnsubscribes(loginName, loginPassword, campaignID, startTime, endTime)

Dim loginName As String = "Spread@reasonables.com"
Dim loginPassword As String = "Spread"

Dim campaignID As Integer = 123456
' suggest dateTime string format "yyyy-MM-ddTHH:mm:ss" ,such as "2023-02-06T12:11:21" .
Dim startTime As DateTime = "2023-02-06T12:11:21"
Dim endTime As DateTime = "2023-02-07T12:11:21"

'Create a SpreadWebService object and use its method.
Dim MySpread As New SpreadWebService
Dim result As DataSet = MySpread.GetCampaignUnsubscribes(loginName, loginPassword, campaignID, startTime, endTime)

  /**
    * @name     GetCampaignUnsubscribes
    * @function Get unsubscribe report in a period of time for a campaign
    * @param
    *  loginEmail        The login email of your Spread account.
    *  password 	 The login password of your Spread account.
    *  campaignID        The id of  campaign.
    *  startDate         Start time.
    *  endDate           End time.
    *  @return
    *  		dataset.
    *  Dataset Columns:
	 subscriber_email, isSuccess,sending_status_time
    */
    public function GetCampaignUnsubscribes($loginEmail,$password,$campaignID,$startDate,$endDate){
        $paraArray = array(
	            'loginEmail' 	 	=> $loginEmail,
	            'password'     	 	=> $password,
		    'campaignID'     	        => $campaignID,
		    'startDate'     	        => $startDate,
		    'endDate'     	 	=> $endDate
        );
        $Client = new SoapClient("http://service.rspread.com/Service.asmx?WSDL");
        Return $Client -> GetCampaignUnsubscribes( $paraArray );
    }
         
No sample.