Retrieve a Campaign API - Smarter Email Marketing Solution | Effective Email Campaigns | e-Marketing Campaigns | Effective Email Marketing Response | Email Automation | Advanced Email Segmentation | Bulk Email | Newsletter Blast | Newsletter email marketing

Retrieve a Campaign

Home /Knowledgebase / SEMSblast API /Retrieve a Campaign

Account Functions

Groups

Subscribers

Newsletters

Campaigns

Use the API to retrieve information about a campaign.

Request

Submit an XML Request with the following details:

Post URL: http://cp.semsblast.com/api/v3.0/campaigns/viewCampaign/

Fields to Post
apiKey	String	REQUIRED	The APIKey of the requesting user.
campaignID	Int	REQUIRED	The ID of the campaign to retrieve.

Response

Data Sent Back
error	Int	Indicates wether an error has occured. 0 for no error. 1 for error.
status	String	If there's been an error, a text description of the error that occured will be here.
campaignCnt	Int	The number of campaigns returned
campaign
----> campaignID	Int	The Campaign ID
----> campaignName	String	The friendly name of the campaign
----> dateCreated	Date Time	The date the campaign was created.
----> sentFrom	String	The name the email was sent from.
----> subject	String	The email subject.
----> startDate	Date Time	The date the campaign is/was scheduled to start.
----> status	Int	The status of the campaign. 0 = Scheduled, 1 = Queued, 2 = Copying Subscribers, 3 = Sending Campaign, 4 = Complete.
----> groupID	Int	The ID of the group sent to.
----> emailFrom	String	The email address the campaign was sent from.
----> totalRecipients	Int	The total number of recipients who were sent the campaign.
----> opened	Int	The number of emails read/opened.
----> clicks	Int	The number of links clicked.
----> unsubscribers	Int	The number of unsubscribers.
----> bounced	Int	The number of emails that bounced.

Sample request XML

Sample response XML

<xml>
     <error>0</error>
     <status>success</status>
     <campaignCnt>1</campaignCnt>
     <campaign>
          <campaignID>1234</campaignID>
          <campaignName>Sample Campaign</campaignName>
          <dateCreated>2014-06-01 11:00</dateCreated>
          <sentFrom>Test User</sentFrom>
          <subject>My Sample Campaign</subject>
          <startDate>2014-06-02 12:00</startDate>
          <status>4</status>
          <groupID>1314</groupID>
          <emailFrom>my@emailaddress.com</emailFrom>
          <totalRecipients>12</totalRecipients>
          <opened>3/opened>
          <clicks>2</clicks>
          <unsubscribers>1</unsubscribers>
          <bounced>2</bounced>
     </campaign>
</xml>