API for Automation360

1. Inicio
2. Integraciones
3. SendPulse service REST API
4. API for Automation360

Get Statistics about an Automation Flow

To get information about the flow, send a GET request to:

https://api.sendpulse.com/a360/autoresponders/{ID}

Request parameter:

If request is successful, you will receive a response:

{
    "autoresponder": {
        "id": 281013, // flow identifier
        "name": "New autoresponder 2020-06-23", // flow name
        "status": 1,
        "created": "2020-06-23 11:06:25", 
        "changed": "2020-06-23 11:06:25" 
    },
    "flows": [
        {
            "id": 467510, // element identifier used to get statistics
            "main_id": 281013, // the id of the flow to which the element belongs (coincides with the value from the URL in the account when viewing)
            "af_type": "maintrigger", // element's type, see a description below
            "created": "2020-06-23 14:06:25", 
            "last_send": "2020-06-25 17:05:40", 
            "task": null
        },
        {
            "id": 467511, 
            "main_id": 281013,
            "af_type": "email",
            "created": "2020-06-23 14:06:25",
            "last_send": "2020-06-25 17:05:41",
            "task": {
                "id": 12018943, // campaign identifier 
                "address_book_id": 0, // identifier of the mailing list that triggers the flow; if a flow is triggered by an event, parameter will equal 0  
                "message_title": "Thank you for the order, 7136062", 
                "sender_mail_address": "smtp_test@e.cn.ua", 
                "sender_mail_name": "smtp_test", 
                "created": "2020-06-23 14:06:25" 
            }
        },
        {
            "id": 486649,
            "main_id": 281013,
            "af_type": "push",
            "created": "2020-07-09 15:40:12",
            "last_send": null,
            "task": {
                "id": 3016415, 
                "website_id": 14699, 
                "title": "push_title", 
                "body": "push_text", 
                "icon": "/files/push/7023639/tasks/3016415/icons/577416720c24.png", 
                "url_for_click": "https://google.com", 
                "created": "2020-07-09 15:40:12" 
            }
        },
        {
            "id": 486657,
            "main_id": 281013,
            "af_type": "sms",
            "created": "2020-07-09 15:48:22",
            "last_send": null,
            "task": {
                "id": 12110431, 
                "address_book_id": 0, // identifier of the mailing list that triggers the flow; if a flow is triggered by an event, parameter will equal 0 
                "sms_body": "sms_text", 
                "sms_sender_name": "Bakler", 
                "created": "2020-07-09 15:48:22" 
            }
        }
    ],
    "starts": 18, 
    "in_queue": 0, 
    "end_count": 18, 
    "send_messages": 16, 
    "conversions": 0
}

Flow statuses:

Code	Description
0	New
1	Active
3	Pause

All parameters with dates that you receive via API are given according to the GMT +00:00 time zone

To get information about the flow for a chosen period, send a GET request to:

https://api.sendpulse.com/a360/autoresponders/{ID}/group-stat-filtered?filter=JSON&limit=10&offset=0

Request parameters:

A sample of a filter parameter in JSON string before URL encoding:

{
   "type":"group",
   "expression":"and",
   "fields":{                         //Array with filters
      "send_date_from":{              //Filter by date, search for statistics starting from a specific date
         "name":"user_stat_date",
         "expression":"gte",
         "value":"2020-10-01"         
      },
      "send_date_to":{                //Filter by date, search for statistics ending with date
         "name":"user_stat_date",
         "expression":"lte",
         "value":"2020-10-31"         
      }
   }
}

Sample of a filter parameter in JSON string after URL encoding:

%7B%22type%22:%22group%22,%22expression%22:%22and%22,%22fields%22:%7B%22send_date_from%22:%7B%22name%22:%22user_stat_date%22,%22expression%22:%22gte%22,%22value%22:%222020-10-01%22%7D,%22send_date_to%22:%7B%22name%22:%22user_stat_date%22,%22expression%22:%22lte%22,%22value%22:%222020-10-31%22%7D%7D%7D

Get Statistics about Each Element

To get statistic about each element in the flow, send a GET request to:

https://api.sendpulse.com/a360/autoresponders/{ID}/total-stats

Request parameters:

A request example with additional parameters:

https://api.sendpulse.com/a360/autoresponders/{ID}/total-stats?flow_type=type_name

If request is successful, you will receive a response:

{
    "autoresponder": {
        "id": 292692,
        "name": "New automation 2020-11-23",
        "status": 1,
        "created": "2020-11-23 08:42:47",
        "changed": "2020-11-23 08:42:47"
    },
    "flows": [
        {
            "type": "maintrigger",
            "flow_id": 641433,
            "executed": 3,
            "deleted": 0,
            "last_send": "2020-11-23 10:52:00"
        },
        {
            "type": "filter",
            "flow_id": 641434,
            "executed": 3,
            "positive": 1,
            "negative": 1,
            "stopped": 1,
            "last_send": "2020-11-23 10:52:00"
        },
        {
            "type": "goal",
            "flow_id": 641435,
            "executed": 1,
            "last_send": "2020-11-23 10:48:54"
        },
        {
            "type": "action",
            "flow_id": 641436,
            "executed": 1,
            "last_send": "2020-11-23 10:48:54"
        },
        {
            "type": "sms",
            "flow_id": 641437,
            "executed": 1,
            "sent": 0,
            "delivered": 0,
            "errors": 0,
            "last_send": null
        },
        {
            "type": "email",
            "flow_id": 641438,
            "sent": 3,
            "error": 0,
            "opened": 0,
            "clicked": 0,
            "marked_as_spam": 0,
            "unsubscribed": 0,
            "delivered": 3,
            "last_send": "2020-11-23 10:52:00"
        },
        {
            "type": "push",
            "flow_id": 641439,
            "sent": 0,
            "delivered": 0,
            "clicked": 0,
            "errors": 0,
            "last_send": null
        }
    ]
}

Get Statistics about the “Start” Element

To get overall statistics about the "Start" element of the flow (main-trigger), send a GET request to:

https://api.sendpulse.com/a360/stats/main-trigger/{ID}/group-stat

Request parameter:

If request is successful, you will receive a response:

{
   "data":{
      "flow_id":{ID}, // identifier of the main element in the flow
      "executed":1, // how many times was executed
      "deleted":0 // how many subscribers was deleted from the flow
   }
}

To get overall statistics about the "Start" element of the flow (main-trigger) for a chosen period, send a GET request to:

https://api.sendpulse.com/a360/stats/main-trigger/{ID}/group-stat-filtered?filter=JSON&limit=10&offset=0

Request parameters:

If request is successful, you will receive a response:

{
   "data": {
      "executed": "22", 
      "deleted": "1", 
      "last_send": "2020-10-13 07:28:28" 
   }
}

To get a list of the contacts who triggered the main-trigger, send a GET request to:

https://api.sendpulse.com/a360/stats/main-trigger/{ID}/addresses?limit=10&offset=0&sortDirection=desc&sortField=id

Request parameters:

If request is successful, you will receive a response:

{
  "data": [
    {
      "flow_id": {ID},
      "email": "subscriber's email",
      "phone": "subscriber's phone",
      "event_id": "{EVENT_ID}", // unique subscriber identifier
      "email_b64": "EMAIL IN BASE64 ENCODE",
      "execution_date": "time when subscriber got to the flow"
    }
  ],
  "total": 1 // how many times flow was started
}

Get Statistics about the “Email” Element

To get overall statistics about an "Email" element in the flow, send a GET request to::

https://api.sendpulse.com/a360/stats/email/{ID}/group-stat

Request parameters:

If request is successful, you will receive a response:

{
    "data": {
        "flow_id": 467511, 
        "task": {
            "id": 12018943, 
            "address_book_id": 0, // identifier of the mailing list that triggers the flow; if a flow is triggered by an event, parameter will equal 0 
            "message_title": "Thank you for your order, 7136062", 
            "sender_mail_address": "smtp_test@e.cn.ua", 
            "sender_mail_name": "smtp_test", 
            "created": "2020-06-23 14:06:25" 
        },
        "sent": 16, 
        "delivered": 16, 
        "opened": 16, 
        "clicked": 0, 
        "errors": 0,  
        "unsubscribed": 0, 
        "marked_as_spam": 0, 
        "last_send": "2020-06-25 17:05:41" 
    }
}

To get overall statistics about an "Email" element in the flow for a chosen period of time, send a GET request to::

https://api.sendpulse.com/a360/stats/email/{ID}/group-stat-filtered?filter=JSON&limit=10&offset=0

Request parameters:

If request is successful, you will receive a response:

{
   "data":{
      "sent":"10",
      "errors":"0",
      "opened":"9",
      "clicked":"10",
      "marked_as_spam":"0",
      "unsubscribed":"0",
      "delivered":"0",
      "last_send":"2020-10-13 07:29:07"
   }
}

To get a list of the contacts to whom emails were sent, send a GET request to::

https://api.sendpulse.com/a360/stats/email/{ID}/addresses?&limit=10&offset=0&sortDirection=desc&sortField=id

Request parameters:

If request is successful, you will receive a response:

{
  "data": [
    {
      "id": 151880841, 
      "email": "EMAIL", 
      "email_b64": "BASE64 EMAIL", // email in base64_encode
      "event_id": "dcf8e501483f4582fdb76a1831a74477", // unique identifier of launching subscriber
      "delivered_status": 1, 
      "delivered_status_description": "sent", 
      "is_spam": 0, // 1 - if recipient complained that your email is spam, 0 - if not.
      "is_unsubscribe": 0, // 1 - if user unsubscribed, 0 - if not
      "phone": PHONE, 
      "sent_date": "2020-04-09 11:17:43", 
      "delivered_date": "2020-04-09 11:17:47", 
      "open_date": null, // null if user did not open email, value of date if email was opened
      "redirect_date": null, // null if user did not сlicked links in email, value of date if links were clicked
      "updated": "2020-04-09 11:17:47" 
    }
  ],
  "total": 1 
}

Email delivery statuses description:

Code	Status	Description
0	no_status	Sent
1	delivered	Sent
2	deliveryfailed	Not delivered for other reasons
3	unsubscribe	Unsubscribed
4	rejectedyus	Rejected by service
5	brokenemail	Wrong email address
6	tmpanavailable	Temporarily unavailable
7	emailnotexist	Email address does not exist
8	serverspam	Server rejected email address because of spam
9	userspam	User complained about spam
10	mboxfull	Mailbox is full
11	domainnotexist	Domain does not exist
12	no_status	Sent
13	no_status	Sent
14	badrecipient	Bad recipient

Get Statistics about the “Push” Element 

To get overall statistics about a "Push" element, send a GET request to:

https://api.sendpulse.com/a360/stats/push/{ID}/group-stat

Request parameter:

If request is successful, you will receive a response:

{
  "data": {
    "flow_id": {ID}, 
    "sent": 9, 
    "delivered": 3, 
    "clicked": 6, 
    "errors": 0, 
    "last_send": "2020-02-28 12:18:23" 
  }
}

To get overall statistics about a "Push" element in the flow for a chosen period of time, send a GET request to:

https://api.sendpulse.com/a360/stats/push/{ID}/group-stat-filtered?filter=JSON&limit=10&offset=0

Request parameters:

A sample of a filter parameter in JSON string before URL encoding:

{
   "type":"group",
   "expression":"and",
   "fields":{                         //Array with filters
      "send_date_from":{              //Filter by date, search for statistics starting from a specific date
         "name":"user_stat_date",
         "expression":"gte",
         "value":"2020-10-01"         
      },
      "send_date_to":{                //Filter by date, search for statistics ending with date
         "name":"user_stat_date",
         "expression":"lte",
         "value":"2020-10-31"         
      }
   }
}

Sample of a filter parameter in JSON string after URL encoding:

%7B%22type%22:%22group%22,%22expression%22:%22and%22,%22fields%22:%7B%22send_date_from%22:%7B%22name%22:%22user_stat_date%22,%22expression%22:%22gte%22,%22value%22:%222020-10-01%22%7D,%22send_date_to%22:%7B%22name%22:%22user_stat_date%22,%22expression%22:%22lte%22,%22value%22:%222020-10-31%22%7D%7D%7D

If request is successful, you will receive a response:

{
   "data":{
      "sent":"10",
      "delivered":"0",
      "clicked":"9",
      "errors":"10",
      "last_send":"2020-10-13 07:29:07"
   }
}

To get a list of the subscribers to whom push notifications were sent, send a GET request to: 

https://api.sendpulse.com/a360/stats/push/{ID}/addresses?limit=10&offset=0

Request parameters:

If request is successful, you will receive a response:

{
  "data": [
    {
      "id": 424633, 
      "email": "EMAIL", 
      "email_b64": "BASE64 EMAIL", // email in base64_encode
      "event_id": "3cc000ab9cff4d41f9fc8d025be2b766", // unique identifier of launching subscriber
      "phone": null, 
      "status": 0, 
      "is_sent": 1, // 1 if was sent, 0 if not
      "is_delivered": 0, // 1 if was delivered, 0 if not
      "is_redirected": 0, // 1 if links were clicked, 0 if not
      "sent_date": "2020-02-28 12:18:23" 
    }
  ],
  "total": 1 
}

Statuses description:

Code	Description
0	Sent
1	Unsubscribed

Get Statistics about the “SMS” Element  

To get overall statistics about an "SMS" element, send a GET request to:

https://api.sendpulse.com/a360/stats/sms/{ID}/group-stat

Request parameters:

If request is successful, you will receive a response:

{
  "data": {
    "flow_id": {ID}, 
    "executed": 2, 
    "sent": 2, 
    "delivered": 2, 
    "opened": null, 
    "clicked": null, 
    "errors": 0, 
    "last_send": "2020-04-09 11:17:44" 
  }
}

To get overall statistics about "SMS" element in the flow for a chosen period of time, send a GET request to:

https://api.sendpulse.com/a360/stats/sms/{ID}/group-stat-filtered?filter=JSON&limit=10&offset=0

Request parameters:

A sample of a filter parameter in JSON string before URL encoding:

{
   "type":"group",
   "expression":"and",
   "fields":{                         //Array with filters
      "send_date_from":{              //Filter by date, search for statistics starting from a specific date
         "name":"user_stat_date",
         "expression":"gte",
         "value":"2020-10-01"         
      },
      "send_date_to":{                //Filter by date, search for statistics ending with date
         "name":"user_stat_date",
         "expression":"lte",
         "value":"2020-10-31"         
      }
   }
}

Sample of a filter parameter in JSON string after URL encoding:

%7B%22type%22:%22group%22,%22expression%22:%22and%22,%22fields%22:%7B%22send_date_from%22:%7B%22name%22:%22user_sent_date%22,%22expression%22:%22gte%22,%22value%22:%222020-10-01%22%7D,%22send_date_to%22:%7B%22name%22:%22user_sent_date%22,%22expression%22:%22lte%22,%22value%22:%222020-10-31%22%7D%7D%7D

If request is successful, you will receive a response:

{
   "data":{
      "sent":"10",
      "executed":"0",
      "delivered":"9",
      "errors":"10",
      "last_send":"2020-10-13 07:29:07"
   }
}

To get a list of the subscribers to whom SMS were sent, send GET request to: 

https://api.sendpulse.com/a360/stats/sms/{ID}/addresses?limit=10&offset=0&sortDirection=desc&sortField=id

Request parameters:

If request is successful, you will receive a response:

{
  "data": [
    {
      "id": 2214741, 
      "phone": PHONE, 
      "status": 2, 
      "event_id": "dcf8e501483f4582fdb76a1831a74477", // unique identifier of launching subscriber:
      "sender": "sendpulse", 
      "body": "BODY", 
      "price": { 
        "USD": "0.07900",
        "RUR": "4.50000",
        "UAH": "1.93000",
        "EUR": "0.06400",
        "GBP": "0.05600",
        "BRL": "0.26000",
        "BYN": "0.16000",
        "KZT": "22.50000",
        "MXN": "1.49000",
        "CLP": "60.44000",
        "NGN": "30.35000"
      },
      "cur": "USD", // current user currency
      "email": "EMAIL", 
      "sent_date": "2020-04-09 11:17:44" 
    }
  ],
  "total": 1 
}

Statuses description:

Code	Description
0	Sent
1	Not delivered
3	Delivered
4	Wrong phone number
5	Provider rejected as a spam
6	Duplicate
7	Refreshing statistic

Get Statistics about the “Messenger” Element  

To get overall statistics about an "Messenger" element, send a GET request to:

https://api.sendpulse.com/a360/stats/messenger/{ID}/group-stat

Request parameter:

If request is successful, you will receive a response:

{
   "data": {
      "flow_id": 234728,
      "executed": 7, 
      "sent": 7, 
      "last_send": "2021-02-02 14:41:51"
   }
}

To get overall statistics about "Messenger" element in the flow for a chosen period of time, send a GET request to:

https://api.sendpulse.com/a360/stats/messenger/{ID}/group-stat-filtered?filter=JSON&limit=10&offset=0

Request parameters:

If request is successful, you will receive a response:

{
   "data": {
      "sent": "8",
      "executed": "8",
      "last_send": "2021-02-02 14:41:51"
   }
}

Get Statistics about the "Filter" Element  

To get overall statistics about a "Filter" element, send a GET request to: 

https://api.sendpulse.com/a360/stats/filter/{ID}/group-stat

Request parameter:

If request is successful, you will receive a response:

{
  "data": {
    "flow_id": {ID}, 
    "executed": 2, 
    "last_send": "2020-04-09 11:17:44" 
  }
}

To get overall statistics about a "Filter" element for a chosen period, send a GET request to:

https://api.sendpulse.com/a360/stats/filter/{ID}/group-stat-filtered?filter=JSON&limit=10&offset=0

Request parameters:

If request is successful, you will receive a response:

{
  "data": {
    "flow_id": {ID}, 
    "executed": 2, 
    "last_send": "2020-04-09 11:17:44" 
  }
}

To get a list of the contacts for whom the "Filter" element was executed, send a GET request to:

https://api.sendpulse.com/a360/stats/flow-operator/{ID}/addresses?limit=10&offset=0&sortDirection=desc&sortField=execution_date

Request parameters:

If request is successful, you will receive a response:

{
  "data": [
    {
      "email": "EMAIL", 
      "email_b64": "BASE64 EMAIL", 
      "phone": PHONE, 
      "event_id": "dcf8e501483f4582fdb76a1831a74477", // unique identifier of launching subscriber:
      "execution_date": "2020-04-09 11:17:44" 
    }
  ],
  "total": 1 
}

Get Statistics about the "Condition" Element   

To get overall statistics about a "Condition" element, send a GET request to:

https://api.sendpulse.com/a360/stats/trigger/{ID}/group-stat

Request parameter:

If request is successful, you will receive a response:

{
  "data": {
    "flow_id": {ID}, 
    "executed": 2, 
    "last_send": "2020-04-09 11:17:44" 
  }
}

To get overall statistics about a "Сondition" element for a chosen period, send a GET request to:

https://api.sendpulse.com/a360/stats/email/{ID}/group-stat-filtered?filter=JSON&limit=10&offset=0

Request parameters:

If request is successful, you will receive a response:

{
  "data": {
    "flow_id": {ID}, 
    "executed": 2, 
    "last_send": "2020-04-09 11:17:44" 
  }
}

To get a list of the contacts, for whom "Condition" element was executed, send GET request to: 

https://api.sendpulse.com/a360/stats/flow-operator/{ID}/addresses?limit=10&offset=0&sortDirection=desc&sortField=execution_date

Request parameters:

If request is successful, you will receive a response:

{
  "data": [
    {
      "email": "EMAIL", 
      "email_b64": "BASE64 EMAIL", 
      "phone": PHONE, 
      "event_id": "dcf8e501483f4582fdb76a1831a74477", // unique identifier of launching subscriber:
      "execution_date": "2020-04-09 11:17:44" 
    }
  ],
  "total": 1 
}

Get Statistics about the "Goal" Element   

To get overall statistics about a "Goal" element, send a GET request to: 

https://api.sendpulse.com/a360/goal/{ID}/group-stat

Request parameter:

If request is successful, you will receive a response:

{
  "data": {
    "flow_id": {ID}, 
    "executed": 2, 
    "sent": 2, 
    "delivered": 2, 
    "opened": null, 
    "clicked": null, 
    "errors": 0, 
    "last_send": "2020-04-09 11:17:44" 
  }
}

To get overall statistics about a "Goal" element for a chosen period, send a GET request to:

https://api.sendpulse.com/a360/stats/goal/{ID}/group-stat-filtered?filter=JSON&limit=10&offset=0

Request parameters:

If request is successful, you will receive a response:

{
   "data": {
      "executed": "4", 
      "last_send": "2020-10-06 13:38:56" 
   }
}

To get a list of the contacts for whom the "Goal" element was executed, send a GET request to:  

https://api.sendpulse.com/a360/stats/flow-operator/{ID}/addresses?limit=10&offset=0&sortDirection=desc&sortField=execution_date

Request parameters:

If request is successful, you will receive a response:

{
  "data": [
    {
      "email": "EMAIL", 
      "email_b64": "BASE64 EMAIL", 
      "phone": PHONE, 
      "event_id": "dcf8e501483f4582fdb76a1831a74477", // unique identifier of launching subscriber:
      "execution_date": "2020-04-09 11:17:44" 
    }
  ],
  "total": 1 
}

Get Statistics about the "Action" Element  

To get overall statistics about an "Action" element, send a GET request to: 

https://api.sendpulse.com/a360/stats/action/{ID}/group-stat

Request parameter:

If request is successful, you will receive a response:

{
  "data": {
    "flow_id": {ID}, 
    "executed": 2, 
    "last_send": "2020-04-09 11:17:44" 
  }
}

To get overall statistics about an "Action" element for a chosen period, send a GET request to:

https://api.sendpulse.com/a360/stats/action/{ID}/group-stat-filtered?filter=JSON&limit=10&offset=0

Request parameters:

If request is successful, you will receive a response:

{
    "data": {
        "executed": "5", 
        "last_send": "2020-10-18 12:36:38" 
    }
}

To get a list of the contacts, for whom the "Action" element was executed, send a GET request to: 

https://api.sendpulse.com/a360/stats/flow-operator/{ID}/addresses?limit=10&offset=0&sortDirection=desc&sortField=execution_date

Request parameters:

If request is successful, you will receive a response:

{
  "data": [
    {
      "email": "EMAIL", 
      "email_b64": "BASE64 EMAIL", 
      "phone": PHONE, 
      "event_id": "dcf8e501483f4582fdb76a1831a74477", 
      "execution_date": "2020-04-09 11:17:44" 
    }
  ],
  "total": 1 
}

Get the Flow Conversions List

There are two types of conversion:

• stopping the flow with an event and enabling this option in the “Start” element (main-trigger) options;
• reaching to the "goal" element

To get information about the amount of executed conversions and amount of conversions of each type in the flow, send GET request to:

https://api.sendpulse.com/a360/autoresponders/{id}/conversions

Request parameter:

If request is successful, you will receive a response:

{
    "data": {
        "total_conversions": 5, 
        "maintrigger_conversions": 1, 
        "goal_conversions": 4, 
        "maintrigger": { 
            "id": 233500,
            "main_id": 127820,
            "af_type": "maintrigger",
            "created": "2020-04-28 18:00:09",
            "last_send": "2020-04-28 18:13:44",
            "conversions": 1
        },
        "goals": [  
            {
                "id": 233502,
                "name": "left",
                "main_id": 127820,
                "af_type": "goal",
                "created": "2020-04-28 18:00:09",
                "conversions": 3
            },
            {
                "id": 233503,
                "name": "right",
                "main_id": 127820,
                "af_type": "goal",
                "created": "2020-04-28 18:00:09",
                "conversions": 1
            }
        ]
    }
}

Note: total_conversions must be equal to the sum of two of the following parameters:  maintrigger_conversions and goal_conversions; also, be equal to the sum of parameters maintrigger_conversions and goals.

To get information about the amount of executed conversions and amount of conversions of each type in the flow, send GET request to:

https://api.sendpulse.com/a360/autoresponders/{id}/conversions

Request parameters:

If request is successful, you will receive a response:

{
    "data": {
        "total_conversions": 5, 
        "maintrigger_conversions": 1, 
        "goal_conversions": 4, 
        "maintrigger": { 
            "id": 233500,
            "main_id": 127820,
            "af_type": "maintrigger",
            "created": "2020-04-28 18:00:09",
            "last_send": "2020-04-28 18:13:44",
            "conversions": 1
        },
        "goals": [  
            {
                "id": 233502,
                "name": "left",
                "main_id": 127820,
                "af_type": "goal",
                "created": "2020-04-28 18:00:09",
                "conversions": 3
            },
            {
                "id": 233503,
                "name": "right",
                "main_id": 127820,
                "af_type": "goal",
                "created": "2020-04-28 18:00:09",
                "conversions": 1
            }
        ]
    }
}

Get a List of the Contacts That Converted

To get a list of the subscribers who converted via either method, send a GET request to:

https://api.sendpulse.com/a360/autoresponders/{ID}/conversions/list/all

To get a list of conversions completed using the"stop flow by event" option, send a GET request to: 

https://api.sendpulse.com/a360/autoresponders/{ID}/conversions/list/maintrigger

To get a list of conversions completed using the "Goal" element, send a GET request to:  

https://api.sendpulse.com/a360/autoresponders/{ID}/conversions/list/goal

To get a list of conversions completed using the specific "Goal" element, send a GET request to:  

https://api.sendpulse.com/a360/autoresponders/{ID}/conversions/list/goal{{goalID}}

Request parameters:

If request is successful, you will receive a response:

{
    "total": 5,
    "items": [
        {
            "id": 40941,
            "conversion_type": "maintrigger",
            "flow_id": 233500,
            "email": "m.jim@sendpulse.com",
            "phone": null,
            "conversion_date": "2020-04-28 18:13:53",
            "start_date": "2020-04-28 18:13:44"
        },
        {
            "id": 40940,
            "conversion_type": "goal",
            "flow_id": 233502,
            "email": "m.jim@sendpulse.com",
            "phone": null,
            "conversion_date": "2020-04-28 18:03:44",
            "start_date": "2020-04-28 18:03:42"
        },
        {
            "id": 40939,
            "conversion_type": "goal",
            "flow_id": 233502,
            "email": "m.jim@sendpulse.com",
            "phone": null,
            "conversion_date": "2020-04-28 18:02:52",
            "start_date": "2020-04-28 18:02:50"
        },
        {
            "id": 40938,
            "conversion_type": "goal",
            "flow_id": 233503,
            "email": "m.jim@sendpulse.com",
            "phone": null,
            "conversion_date": "2020-04-28 18:02:43",
            "start_date": "2020-04-28 18:02:40"
        },
        {
            "id": 40937,
            "conversion_type": "goal",
            "flow_id": 233502,
            "email": "m.jim@sendpulse.com",
            "phone": null,
            "conversion_date": "2020-04-28 18:01:59",
            "start_date": "2020-04-28 18:01:56"
        }
    ]
}

To get a list of the subscribers who converted via either method for a chosen period, send a GET request to:

https://api.sendpulse.com/a360/autoresponders/{ID}/conversions/list/all/group-stat-filtered?filter=JSON&limit=10&offset=0

To get a list of conversions completed using the"stop flow by event" option for a chosen period, send a GET request to: 

https://api.sendpulse.com/a360/autoresponders/{ID}/conversions/list/maintrigger/group-stat-filtered?filter=JSON&limit=10&offset=0

To get a list of conversions completed using the "Goal" element for a chosen period, send a GET request to:  

https://api.sendpulse.com/a360/autoresponders/{ID}/conversions/list/goals/group-stat-filtered?filter=JSON&limit=10&offset=0

To get a list of conversions completed using the specific "Goal" element for a chosen period, send a GET request to:  

https://api.sendpulse.com/a360/autoresponders/{ID}/conversions/list/goal/{goalId}/group-stat-filtered?filter=JSON&limit=10&offset=0

Request parameters:

Request errors

In case of validation errors, check the formatting of your API request, if it is wrong you will get a 400 HTTP code with information about this error. 

Example of errors structure:

{
    "type": "validation_error",
    "messages": {
        "limit": [
            "The limit field is required."
        ],
        "offset": [
            "The offset field is required."
        ]
    }
}

If there is not any data returned for this method, you will get a 404 error code.