List campaign steps

This endpoint will list all the steps on a specific campaign. It's worth reviewing this article on how A/B tests work to better understand our "step" architecture and its relationship with "templates".

Endpoint

Text

GET https://api.mailstand.com/campaigns/{{campaign_id}}/steps

Parameters

Field	Required	Description
campaign_id	true	The Campaign ID that you want to query

200 Response

JSON

{
  "status": "ok",
  "days_left": 0,
  "days_left_date": "Complete",
  "days_left_display": "0 days (Complete)",
  "data": [
    {
      "id": "step_5lNRJSP3xvCGvbjRypssBWO12d",
      "order": 1,
      "status": "live",
      "type": "auto_email",
      "wait_time": 0,
      "left_to_send": 0,
      "already_sent": 6,
      "out_of": 6,
      "templates": [
        {
          "id": "temp_AllYF4tI85O6nXG0Ysdq1WFnt",
          "test_letter": "A",
          "name": "First Email",
          "status": "live",
          "new_thread": true,
          "subject": "Connecting",
          "body_text": "Hey {{first_name}},This is Mike with Mailstand - the cheapest cold email tool out there that allows ",
          "sent": 3,
          "opened": 33.33,
          "opened_num": 1,
          "clicked": 0,
          "clicked_num": 0,
          "replied": 33.33,
          "replied_num": 1,
          "unsubscribed": 0,
          "unsubscribed_num": 0
        },
        {
          "id": "temp_W5fZuryddawMuQUrMtjR4k",
          "test_letter": "B",
          "name": "First Email - Test B",
          "status": "live",
          "new_thread": true,
          "subject": "Connecting About Cold Email",
          "body_text": "Hey {{first_name}},This is Mike with Mailstand - the cheapest cold email tool out there that allows ",
          "sent": 2,
          "opened": 50,
          "opened_num": 1,
          "clicked": 0,
          "clicked_num": 0,
          "replied": 50,
          "replied_num": 1,
          "unsubscribed": 0,
          "unsubscribed_num": 0
        },
        {
          "id": "personalized_step_5lNRJwdsvbjRyps6BWOXX",
          "test_letter": "PER",
          "name": "Personalized Emails",
          "status": "live",
          "new_thread": null,
          "subject": null,
          "body_text": null,
          "sent": 1,
          "opened": 0,
          "opened_num": 0,
          "clicked": 0,
          "clicked_num": 0,
          "replied": 0,
          "replied_num": 0,
          "unsubscribed": 0,
          "unsubscribed_num": 0
        }
      ]
    },
    {
      "id": "step_31O2QRG6zasdasaG29pv8u5i",
      "order": 2,
      "status": "live",
      "type": "auto_email",
      "wait_time": 259200,
      "left_to_send": 0,
      "already_sent": 6,
      "out_of": 6,
      "templates": [
        {
          "id": "temp_yiiMsQUasaSzj3MAKeeBU",
          "test_letter": "A",
          "name": "Follow Up",
          "status": "live",
          "new_thread": false,
          "subject": null,
          "body_text": "Hi {{first_name}},Just circling back here! If you send cold email from more than one mailbox its def",
          "sent": 0,
          "opened": 0,
          "opened_num": 0,
          "clicked": 0,
          "clicked_num": 0,
          "replied": 0,
          "replied_num": 0,
          "unsubscribed": 0,
          "unsubscribed_num": 0
        }
      ]
    }
  ]
}

Response Fields

Field	Type	Description
days_left	number	The number of days left until the campaign is complete. This is an estimate based on a few factors like number of emails synced, contacts in queue, mailbox sending speed, breaks in steps, etc...
days_left_date	string	A pretty date display of when the campaign is expected to be complete. If the campaign is done the value will be "Complete".
days_left_display	string	Summary display of the number of days left in the campaign.
data[id]	string	Unique identifier for the step. It always starts with step_.
data[order]	number
data[status]	string	The status of the step. live means that its running. As a default the step is live.
data[type]	string	The type of step. The only option at this point is auto_email.
data[wait_time]	number	How much time are we waiting between steps. This is in ms.
data[left_to_send]	number	The number of contacts that need to still go through this step.
data[already_sent]	number	The number of contacts that have already completed this step.
data[out_of]	number	The total number of contacts that would go through this step.
data[templates]	array	The templates that each step goes through. It's worth reviewing this article on how A/B tests work to better understand our "step" architecture and its relationship with "templates".