Browsing campaigns

With this resource you'll learn how to easily browse and filter campaigns or check campaign stats.

Browsing campaigns:

To get all campaigns created on your Woodpecker account, use the following request:

GET /rest/v1/campaign_list

Sample response:

[ 
    { 
    "id": 4539, 
    "name": "Campaign name", 
    "status": "RUNNING", 
    "created": "2016-04-11T13:14:57+0200", 
    "from_name": "Sender name", 
    "gdpr_unsubscribe": false, 
    "folder_name": "UNASSIGNED", 
    "folder_id": 0, 
    "from_email": "[email protected]", 
    "per_day": 50, 
    "bcc": "", 
    "cc": "" 
    } 
]

A detailed explanation for parameters can be found here.


Filtering campaigns:

If you want to look on the basic information for a specific campaign or check the campaign details, simply use the status or ID parameter. You can use multiple parameters in your query.

GET /rest/v1/campaign_list?id=cid 
GET /rest/v1/campaign_list?status=PAUSED

where cid stands for campaign ID.

Sample response:

[ 
    { 
    "id": 4539, 
    "name": "Campaign name", 
    "status": "RUNNING", 
    "created": "2016-04-11T13:14:57+0200", 
    "from_name": "Sender name", 
    "gdpr_unsubscribe": false, 
    "folder_name": "UNASSIGNED", 
    "folder_id": 0, 
    "from_email": "[email protected]", 
    "per_day": 50, 
    "bcc": "", 
    "cc": "", 
    "stats": { 
        "interested": 2, 
        "not_interested": 4, 
        "maybe_later": 3, 
        "replied": 56, 
        "autoreplied": 10, 
        "bounced": 56, 
        "check": 11, 
        "clicked": 0, 
        "delivery": 193, 
        "invalid": 30, 
        "opened": 137, 
        "prospects": 307, 
        "queue": 27, 
        "sent": 250, 
        "optout": 0, 
        "emails": [ { 
            "subject": "Subject", 
            "msg": "Email body", 
            "timezone": "Europe/Warsaw", 
            "sunFrom": -1,
            "sunTo": -1, 
            "monFrom": -1, 
            "monTo": -1, 
            "tueFrom": -1,
            "tueTo": -1, 
            "wedFrom": 600, 
            "wedTo": 1080, 
            "thuFrom": 600, 
            "thuTo": 1080, 
            "friFrom": -1, 
            "friTo": -1, 
            "satFrom": -1, 
            "satTo": -1, 
            "sunday": [ { 
               "from": -1, 
               "to": -1 
            } ], 
            "monday": [ { 
               "from": -1, 
               "to": -1
            } ], 
            "tuesday": [ { 
               "from": -1, 
               "to": -1 
            } ], 
            "wednesday": [ {
               "from": 600,
               "to": 1080 
            } ], 
            "thursday": [ {
               "from": 600,
               "to": 1080 
            } ],
            "friday": [ {
               "from": -1, 
               "to": -1 
            } ], 
            "saturday": [ { 
               "from": -1, 
               "to": -1 
            } ],
            "track_open": true, 
            "track_click": false, 
            "attach_follow": true, 
            "follow_up": 0, 
            "number": 1, 
            "condition": { 
                 "type": "OPEN", 
                 "operand": "MORE_THAN", 
                 "value": "2" 
            }, 
            "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, 
            "sunday": [ {
               "from": -1,
               "to": -1
            } ], 
            "monday": [ { 
               "from": -1, 
               "to": -1 
            } ], 
            "tuesday": [ {
               "from": -1, 
               "to": -1 
            } ], 
            "wednesday": [ { 
               "from": 600,
               "to": 1080 
            } ], 
            "thursday": [ { 
               "from": 600, 
               "to": 1080
            } ], 
            "friday": [ {
               "from": -1, 
               "to": -1 
            } ], 
            "saturday": [ {
               "from": -1,
               "to": -1 
            } ], 
            "track_open": true, 
            "attach_follow": true, 
            "follow_up": 0, 
            "number": 2, 
            "condition": null, 
            "emailSend": 0, 
            "toSend": 1090, 
            "delivery": 0, 
            "reply_": "0.0%", 
            "reply": 0, 
            "invalid_": "0.0%", 
            "invalid": 0, 
            "bounce_": "0.0%", 
            "bounce": 0 
         } ] 
      } 
  } ]

Parameters:

Name Type Description
id number Campaign ID.
name string Campaign name.
status string Campaign status. Available statuses: DRAFT, RUNNING, EDITED, COMPLETED, PAUSED, RUNNING, DELETED.
created_by string Campaign author.
gdpr_unsubscribe boolean Indicates whether campaign has GDPR unsubscribe enabled or not.
folder_name string Name of a folder campaign is assigned to.
folder_id number ID of a folder campaign is assigned to. 0 stands for general UNASSIGNED folder.
bcc string Blind carbon copy assigned to a particular message in campaign.
cc string Carbon copy assigned to a particular message in campaign.
per_day number Number of emails sent from campaign during one day.
stats JSON object Detailed campaign stats.
prospects number Number of prospects added to a specific campaign.
delivery number Number of prospects who have received an opening email in a specific campaign.
invalid number Number of prospects marked as INVALID in a specific campaign.
bounced number Number of prospects marked as BOUNCED in a specific campaign.
queue number Number of prospects in sending queue.
sent number Number of prospects who received at least one email.
check number Number of all issues referred to prospects in a specific campaign (except manual pause).
autoreplied number Number of prospects who have autoreplied in a specific campaign.
opened number Number of prospects who have opened an opening email in a specific campaign.
optout number Number of prospects who have unsubscribed in a specific campaign.
clicked number Number of prospects who have clicked on a link included in a specific campaign.
replied number Number of prospects who have replied in a specific campaign
interested number Number of prospects marked as “interested”.
maybe_later number Number of prospects marked as “maybe later”.
not_interested number Number of prospects marked as “not interested”.
emails JSON object Detailed stats for emails created in this specific campaign.
subject string Email subject.
msg string Email body.
timezone string Timezone set up for a specific email. Will be used, if option “Use prospect timezone” is not marked or prospect’s timezone is undefined.
sunFrom number This parameter works only for campaigns created before 18th November 2019 and non-IF campaigns created after this date. This parameter doesn’t include different time windows for the same day. Number in delivery time settings pointing an hour from which emails are sent on a particular day. This number is calculated by multiplying hour of start by 60 minutes. For example, number 540 means that emails are sent from 9 AM (9*60=540).
To set up this parameter for different days of the week, use following names: monFrom, tueFrom, wedFrom, thuFrom, friFrom, satFrom.
For IF-campaigns value of this parameter is set to null.
sunTo number This parameter works only for campaigns created before 18th November 2019 and non-IF campaigns created after this date. This parameter doesn’t include different time windows for the same day. Number in delivery time settings pointing an hour to which emails are sent on a particular day. This number is calculated by multiplying hour of start by 60 minutes. For example, number 540 means that emails are sent from 9 AM (9*60=540).
To set up this parameter for different days of the week, use following names: monTo, tueTo, wedTo, thuTo, friTo, satTo.
For IF-campaigns value of this parameter is set to null.
sunday JSON object Number in delivery time settings pointing an hours during which emails are sent on a particular day. You can set up up to three time windows for one day by using “from” and “to” parameters.This number is calculated by multiplying hour of start by 60 minutes. For example, number 540 means that emails are sent from 9 AM (9*60=540).
To set up this parameter for different days of the week, use following names: monday, tuesday, wednesday, thursday, friday, saturday.
track_open boolean Indicates if open tracking is enabled for specific email.
track_click boolean Indicates if open tracking is enabled for any link in a specific email.
attach_follow boolean Indicates if the next email will be sent in the same thread.
follow-up number Number of hours or days before each step is performed (if no reply). This number is calculated by multiplying hours by minutes. For example, number 4320 means that this email will be sent after 3 days after the previous step (3*24*60=4320).
condition JSON object Details of condition following the step it’s mentioned in. If equals null, it means there’s no condition after this step.
type string Defines the type of condition. Available types: OPEN.
operand string Logical expression. Available operands: MORE_THAN.
value string Number indicating the point of condition being fulfilled or not.
number number Number of email in a campaign. Indicates the path in which email will be sent.
emailSend number Number of emails sent on a specific step.
toSend number Number of emails remaining on a specific step.
delivery number Number of emails delivered on a specific step.
open_ string Number of email opens on a specific step divided by the number of emails delivered.
open number Number of email opens on a specific step.
reply_ string Number of replies on a specific step divided by the number of emails delivered.
reply number Number of replies on a specific step.
invalid_ string Number of invalid emails on a specific step divided by the number of emails to send.
invalid number Number of invalid emails on a specific step.
bounce_ string Number of bounced emails on a specific step divided by the number of emails to send.
bounce number Number of bounced emails on a specific step.

Turn knowledge into results

Send follow-ups that make a business thrive