Browsing campaigns

Browsing campaigns

Sample request

GET /rest/v1/campaign_list

Sample response

[
      {
      "id": 4539,
      "name": "Campaign name",
      "status": "RUNNING",
      "from_name": "Sender name",
      "from_email": "sender@email.from",
      "created": "2016-04-11T13:14:57+0200"
   }
]

Available switches

URL parameter Value type Description
id number It can be used to access particular campaign details. If you provide the ID, you will get extra information about campaign's performance.   
status enum It can be used to view campaigns with specific status (available statuses RUNNING, EDITED, PAUSED, DELETED, COMPLETED, DRAFT, STOPPED)

Sample request

/rest/v1/campaign_list?id=num num stands for campaign ID
/rest/v1/campaign_list?id=num1,num2
/rest/v1/campaign_list?status=PAUSED

Sample response

[{
   "id": 18148,
   "name": "Test",
   "status": "STOPPED",
   "from_name": "Erlich Bachman",
   "from_email": "erlich@bachmanity.com",
   "created": "2018-11-18T00:12:25+0100",
    "stats": {
		"interested": 0,
		"not_interested": 0,
		"maybe_later": 0,
		"replied": 0,
		"autoreplied": 0,
		"bounced": 0,
		"check": 0,
		"clicked": 0,
		"delivery": 40,
		"invalid": 0,
		"opened": 24,
		"prospects": 1093,
		"queue": 1050,
		"sent": 40,
		"emails": [{
				"subject": "Subject",
				"msg": "MSG txt",
				"timezone": "Europe/Warsaw",
				"sunFrom": 0 (hour in minutes),
				"sunTo": 0,
				"monFrom": 0,
				"monTo": 0,
				"tueFrom": 0,
				"tueTo": 0,
				"wedFrom": 0,
				"wedTo": 0,
				"thuFrom": 0,
				"thuTo": 0,
				"friFrom": 0,
				"friTo": 0,
				"satFrom": 0,
				"satTo": 0,
				"track_open": true,
				"attach_follow": true,
				"number": 1,
				"emailSend": 40,
				"toSend": 1050,
				"delivery": 40,
				"open_": "60.0%",
				"open": 24,
				"reply_": "0.0%",
				"reply": 0,
				"invalid_": "0.0%",
				"invalid": 0,
				"bounce_": "0.0%",
				"bounce": 0
			      },
			      {
				"subject": "Re: Subject",
				"msg": "MSG txt",
				"timezone": "Europe/Warsaw",
				"sunFrom": 0,
				"sunTo": 0,
				"monFrom": 0,
				"monTo": 0,
				"tueFrom": 0,
				"tueTo": 0,
				"wedFrom": 0,
				"wedTo": 0,
				"thuFrom": 0,
				"thuTo": 0,
				"friFrom": 0,
				"friTo": 0,
				"satFrom": 0,
				"satTo": 0,
				"track_open": true,
				"attach_follow": true,
				"number": 2,
				"emailSend": 0,
				"toSend": 1090,
				"delivery": 0,
				"reply_": "0.0%",
				"reply": 0,
				"invalid_": "0.0%",
				"invalid": 0,
				"bounce_": "0.0%",
				"bounce": 0
				}]
			}
}]

Name of the valuer Value type Description
id number id of a specific campaign. If provided in payload, it willenable edit particular campaign.
name string name of specific campaign 
status enum available statuses: RUNNING, EDITED, PAUSED, DELETED, COMPLETED, DRAFT, STOPPED - written with uppercase
from_name string email "From" name that is viewing by your prospects and is used to define your name, surname and company. Note that when you are using Office365 email name "From" name can't be set up in Woodpecker ( more).
from_email
RFC  2822 format so called angel brackets format eg. "From" name <email@address.com>.
created date 2018-11-18T00:12:25+0100Z
stats JSON element detailed stats section
interested num list of prospects that have been interested (latest status wins) 
not_interested: num list of prospects that were marked as "Not Interested"
maybe_later num list of prospects that were marked as "Maybe Later"    
replied num number of prospects that had replied to particular campaign
autoreplied num how many prospects auto-replied
bounced num bounced prospects number
check num total of prospects market with TO-CHECK status
clicked num prospects that clicked on a link
delivery num number of prospects that will get an email from the cadence/sequence
invalid num number of emails recognized as invalid (internal email validation)
opened num how many emails were opened by the prospects
prospects num total number of prospects in campaign
queue num number of prospects that are queued 
sent num sent emails number 
emails JSON element indicate the section of stats and detailed info responsible for particular email or follow up in campaign 
subject string subject of particular email (custom fields can be used)
msg txt messeage that will be placed in a particular email (HTML avaliable)
timezone string time zone in the tz format e.g. "Europe/Warsaw" ( available options)
sunFrom num delivery time settings. Responsible for pointing the time interval from when the emails are sent on a particular day. So, for example, if you want to send messages from 9 a.m. in your timezone, you should place 540 (9 hours multiple by 60).    
It works for every day of the week, the only difference is the parameter name: 
monFrom, tueFrom, wedFrom, thuFrom, friFrom, satFrom
sunTo num delivery time settings. Responsible for pointing the time interval to when emails are sent on particular day. So, for example, if you want to send messages to 9 p.m. in your timezone you should place 1260 (21 hours multiple by 60).    
Again, it works for every day of the week, the only difference is the parametr name: 
monTo, tueTo, wedTo, thuTo, friTo, satTo 
track_open enum open tracking settings for a specific email in a campaign If set to true - opens are tracked, if set to false - opens are not tracked.
attach_follow enum indicates if the previous email copy needs to be included in a particular step in a sequence. If set to true - the previous email will be included as a thread, if set to false - the previous email/emails will not be included.
number num number of email in sequence
emailSend num shows number of emails that were sent in each step in a sequence
toSend num sum of emails from specific step in campaign that will be send in future 
delivery num number of sent emails that were considered as delivered 
open_ num this field is responsible for showing open rate in percents
open num total number of emails that were opened by prospects 
reply_ num reply rate showing percentage of replies (only includes replies to delivered emails)
reply
num number of emails that got replied to on a specific step 
invalid_ num rate of emails that were considered as non-existing on a particular step in sequence 
invalid: num number of email considered as non-existing 
bounce_ num percent rate of emails that were bounced 
bounce num number of emails considered as bounced by email providers ( more about Woodpecker's statuses)

Still need help? Contact Us Contact Us