ApiDocs - / GetResponse

Our API v3 uses terminology from the previous version of GetResponse.

Campaigns and lists are the same resource. For now, please refer to lists as campaigns.

Our API v4 will use the up-to-date terminology.

Sending GET request to this url, returns collection of CAMPAIGN resources.

You can narrow down list of resources by passing proper query parameters (list of which you can find below in request params section). You can basically search by:

name
isDefault

`name` fields can be a pattern and we will try to match this phrase.

You can specify which page of results you want and how many results per page should be there. You can also specify sort-order using one or more of allowed fields (listed below in request params section).

Last but not least you can even specify which fields from resource you want to get. If you pass param `fields` with list of fields (separated by comma [,]) we will return list of resources with only those fields (we will always add resource id to ensure that you can use that data later on).

This request returns simplified version of campaign resource, that dosn't contains all available fields. To get more information just request one campaign and we will return all available properties.

Returns status code

Request url

/campaigns?query[name]=test&page=1&perPage=100&sort[name]=asc

Request params

Field name

Field type

Field description

query

hash

Used to search only resources that meets criteria. You can specify multiple parameters, then it uses AND logic.

Key	Possible values if fixed
name	*
isDefault	true or false

fields

string

List of fields that should be returned. Id is always returned. Fields should be separated by comma

sort

hash

Enable sorting using specified field (set as a key) and order (set as a value). You can specify multiple fields to sort by.

Key	Possible values if fixed
name	asc,desc
createdOn	asc,desc

page

integer

Specify which page of results return.

perPage

integer

Specify how many results per page should be returned

Example Response

[
    {
        "campaignId": "B",
        "name": "TestCampaigns",
        "description": "New test campaign",
        "languageCode": "EN",
        "isDefault": "true",
        "createdOn": "2014-10-08 15:03:13Z",
        "href": "http://api.getresponse.com/v3/campaigns/B"
    }
]

Method returns campaign according to given campaignId

Returns status code

Request url

/campaigns/1

Request params

Field name	Field type	Field description
fields	string	List of fields that should be returned. Id is always returned. Fields should be separated by comma

Example Response

{
    "campaignId": "B",
    "href": "http://api.getresponse.com/v3/campaigns/B",
    "name": "Campaign name",
    "languageCode": "EN",
    "isDefault": "true",
    "createdOn": "2014-10-08 15:03:13Z",
    "confirmation": {
        "fromField": {
            "fromFieldId": "5",
            "href": "http://api.getresponse.com/v3/from-fields/5"
        },
        "replyTo": {
            "fromFieldId": "5",
            "href": "http://api.getresponse.com/v3/from-fields/5"
        },
        "redirectType": "hosted",
        "redirectUrl": null,
        "mimeType": "text/html"
    },
    "profile": {
        "industryTagId": null,
        "description": "",
        "logo": "",
        "logoLinkUrl": "",
        "title": ""
    },
    "postal": {
        "addPostalToMessages": true,
        "city": "Gdansk",
        "companyName": "Getresponse",
        "country": "Poland",
        "design": "[[name]], [[address]], [[city]], [[state]] [[zip]], [[country]]",
        "state": "pomorskie",
        "street": "Arkonska 6",
        "zipCode": "80-387"
    },
    "optinTypes": {
        "email": "double",
        "import": "single",
        "api": "single",
        "webform": "double"
    },
    "subscriptionNotifications": {
        "status": "enabled",
        "recipients": [
            {
                "fromFieldId": "5",
                "href": "http://api.getresponse.new/v3/from-fields/5"
            }
        ]
    }
}

This call allows to create new campaign. You could specify only campaign name (although it should be unique). The rest of parameters will have default values if not specified. `isDefault` could be set only to true - you just simply cannot "unset" default campaign, only set it.

Returns status code

Example Request Body

{
    "name": "TestCampaign",
    "languageCode": "AA",
    "isDefault": "true",
    "confirmation": {
        "fromField": {
            "fromFieldId": "V"
        },
        "replyTo": {
            "fromFieldId": "M"
        },
        "redirectType": "hosted",
        "redirectUrl": "http://example.com",
        "mimeType": "text/html"
    },
    "profile": {
        "industryTagId": "11",
        "description": "Campaign description",
        "logo": "http://example.com/image.jpg",
        "logoLinkUrl": "http://example.com",
        "title": "Campaign title"
    },
    "postal": {
        "addPostalToMessages": "false",
        "city": "Gdansk",
        "companyName": "GetResponse",
        "country": "Poland",
        "design": "[[name]], [[address]], [[city]], [[state]] [[zip]], [[country]]",
        "state": "Pomorskie",
        "street": "Arkonska 6",
        "zipCode": "80-387"
    },
    "optinTypes": {
        "email": "double",
        "import": "single",
        "webform": "double",
        "api": "double"
    },
    "subscriptionNotifications": {
        "status": "enabled",
        "recipients": [
            {
                "fromFieldId": "V"
            },
            {
                "fromFieldId": "M"
            }
        ]
    }
}

Body params

Field name

Field type

Field description

name^(required)

string

Campaign name which has to be unique in whole GetResponse platform

languageCode

string

Campaign language code (2 letters format)

isDefault

string

Is campaign default for account. You cannot remove default flag, only reassign it to other campaign. Possible values: true, false

confirmation

object

Subscription confirmation email settings

Field name

Field type

Field description

fromField

object

From field email of message

Field name	Field type	Field description
fromFieldId	string	FromFieldId from from-fields resources

replyTo

object

Reply to email of message

Field name	Field type	Field description
fromFieldId	string	FromFieldId from from-fields resources

redirectType

string

What will happen after confirmation of email. Possible values: hosted (subscriber will stay on GetResponse website), customUrl (subscriber will be redirected to provided url)

redirectUrl

string

Url where subscriber will be redirected if redirectType is set to customUrl

profile

object

How campaign will be visible for subscribers

Field name	Field type	Field description
industryTagId	integer	Category of content of campaign
description	string	Short description of campaign content, length 2-255
logo	string	Url of image displayed as campaign logo
logoLinkUrl	string	Url of link in campaign logo
title	string	Title of campaign, length 2-64

postal

object

Postal address of your company

Field name	Field type	Field description
addPostalToMessages	string	Should postal address be sent with all messages from campaign. (For US and Canada it's mandatory)
city	string	City
companyName	string	Company name
design	string	How postal address would be designed in emails. Avaiable fields definitions: [[name]], [[address]], [[city]], [[state]] [[zip]], [[country]]
state	string	State
street	string	Street
zipCode	string	zip code

optinTypes

object

How subscribers will be added to list - with double (with confirmation) or single optin

Field name	Field type	Field description
api	string	Optin type for subscriptions via API. Possible values: single, double
email	string	Optin type for subscriptions via email. Possible values: single, double
import	string	Optin type for subscriptions via import. Possible values: single, double
webform	string	Optin type for subscriptions via webforms and landing pages. Possible values: single, double

subscriptionNotifications

object

Notifications for each subscribed email to Your list

Field name	Field type	Field description
status	string	Are notifications enabled. Possible values: enabled, disabled
recipients	collections	Emails where to send notifications. They have to be defined in account from fields

Example Response

{
    "campaignId": "V",
    "href": "http://api.getresponse.com/v3/campaigns/V",
    "name": "TestCampaign",
    "languageCode": "AA",
    "isDefault": "true",
    "createdOn": "2014-09-29T12:25:13+0000",
    "confirmation": {
        "fromField": {
            "fromFieldId": "V",
            "href": "http://api.getresponse.com/v3/from-fields/V"
        },
        "replyTo": {
            "fromFieldId": "M",
            "href": "http://api.getresponse.com/v3/from-fields/M"
        },
        "redirectType": "customUrl",
        "redirectUrl": "http://example.com",
        "mimeType": "text/html"
    },
    "profile": {
        "industryTagId": "11",
        "description": "Campaign description",
        "logo": "http://example.com/image.jpg",
        "logoLinkUrl": "http://example.com",
        "title": "Campaign title"
    },
    "postal": {
        "addPostalToMessages": "false",
        "city": "Gdansk",
        "companyName": "GetResponse",
        "country": "Poland",
        "design": "[[name]], [[address]], [[city]], [[state]] [[zip]], [[country]]",
        "state": "Pomorskie",
        "street": "Arkonska 6",
        "zipCode": "80-387"
    },
    "optinTypes": {
        "api": "double",
        "email": "double",
        "import": "single",
        "webform": "double"
    },
    "subscriptionNotifications": {
        "status": "enabled",
        "recipients": [
            {
                "fromFieldId": "V",
                "href": "http://api.getresponse.com/v3/from-fields/V"
            },
            {
                "fromFieldId": "M",
                "href": "http://api.getresponse.com/v3/from-fields/M"
            }
        ]
    }
}

Possible Errors

Allows to update campaign prefenrences. You should send only those fields that need to be changed. The rest of properties will stay the same.

Returns status code

Example Request Body

{
    "name": "TestCampaign",
    "languageCode": "AA",
    "isDefault": "true",
    "confirmation": {
        "fromField": {
            "fromFieldId": "V"
        },
        "replyTo": {
            "fromFieldId": "M"
        },
        "redirectType": "hosted",
        "redirectUrl": "http://example.com",
        "mimeType": "text/html"
    },
    "profile": {
        "industryTagId": "11",
        "description": "Campaign description",
        "logo": "http://example.com/image.jpg",
        "logoLinkUrl": "http://example.com",
        "title": "Campaign title"
    },
    "postal": {
        "addPostalToMessages": "false",
        "city": "Gdansk",
        "companyName": "GetResponse",
        "country": "Poland",
        "design": "[[name]], [[address]], [[city]], [[state]] [[zip]], [[country]]",
        "state": "Pomorskie",
        "street": "Arkonska 6",
        "zipCode": "80-387"
    },
    "optinTypes": {
        "email": "double",
        "import": "single",
        "webform": "double"
    },
    "subscriptionNotifications": {
        "status": "enabled",
        "recipients": [
            {
                "fromFieldId": "V"
            },
            {
                "fromFieldId": "M"
            }
        ]
    }
}

Body params

Field name

Field type

Field description

languageCode

string

Campaign language code (2 letters format)

isDefault

string

Is campaign default for account. You cannot remove default flag, only reassign it to other campaign. Possible values: true, false

confirmation

object

Subscription confirmation email settings

Field name

Field type

Field description

fromField

object

From field email of message

Field name	Field type	Field description
fromFieldId	string	FromFieldId from from-fields resources

replyTo

object

Reply to email of message

Field name	Field type	Field description
fromFieldId	string	FromFieldId from from-fields resources

redirectType

string

What will happen after confirmation of email. Possible values: hosted (subscriber will stay on GetResponse website), customUrl (subscriber will be redirected to provided url)

redirectUrl

string

Url where subscriber will be redirected if redirectType is set to customUrl

profile

object

How campaign will be visible for subscribers

Field name	Field type	Field description
industryTagId	integer	Category of content of campaign
description	string	Short description of campaign content, length 2-255
logo	string	Url of image displayed as campaign logo
logoLinkUrl	string	Url of link in campaign logo
title	string	Title of campaign, length 2-64

postal

object

Postal address of your company

Field name	Field type	Field description
addPostalToMessages	string	Should postal address be sent with all messages from campaign. (For US and Canada it's mandatory)
city	string	City
companyName	string	Company name
design	string	How postal address would be designed in emails. Avaiable fields definitions: [[name]], [[address]], [[city]], [[state]] [[zip]], [[country]]
state	string	State
street	string	Street
zipCode	string	zip code

optinType

object

How subscribers will be added to list - with double (with confirmation) or single optin

Field name	Field type	Field description
email	string	Optin type for subscriptions via email. Possible values: single, double
import	string	Optin type for subscriptions via import. Possible values: single, double
webform	string	Optin type for subscriptions via webforms and landing pages. Possible values: single, double
api	string	Optin type for subscriptions via api. Possible values: single, double

subscriptionNotifications

object

Notifications for each subscribed email to Your list

Field name	Field type	Field description
status	string	Are notifications enabled. Possible values: enabled, disabled
recipients	collections	Emails where to send notifications. They have to be defined in account from fields

Example Response

{
    "campaignId": "V",
    "href": "http://api.getresponse.com/v3/campaigns/V",
    "name": "TestCampaign",
    "languageCode": "AA",
    "isDefault": "true",
    "createdOn": "2014-09-29T12:25:13+0000",
    "confirmation": {
        "fromField": {
            "fromFieldId": "V",
            "href": "http://api.getresponse.com/v3/from-fields/V"
        },
        "replyTo": {
            "fromFieldId": "M",
            "href": "http://api.getresponse.com/v3/from-fields/M"
        },
        "redirectType": "customUrl",
        "redirectUrl": "http://example.com",
        "mimeType": "text/html"
    },
    "profile": {
        "industryTagId": "11",
        "description": "Campaign description",
        "logo": "http://example.com/image.jpg",
        "logoLinkUrl": "http://example.com",
        "title": "Campaign title"
    },
    "postal": {
        "addPostalToMessages": "false",
        "city": "Gdansk",
        "companyName": "GetResponse",
        "country": "Poland",
        "design": "[[name]], [[address]], [[city]], [[state]] [[zip]], [[country]]",
        "state": "Pomorskie",
        "street": "Arkonska 6",
        "zipCode": "80-387"
    },
    "optinTypes": {
        "email": "double",
        "import": "single",
        "webform": "double",
        "api": "double"
    },
    "subscriptionNotifications": {
        "status": "enabled",
        "recipients": [
            {
                "fromFieldId": "V",
                "href": "http://api.getresponse.com/v3/from-fields/V"
            },
            {
                "fromFieldId": "M",
                "href": "http://api.getresponse.com/v3/from-fields/M"
            }
        ]
    }
}

Possible Errors

1000

Allows to retrieve all contacts from given campaigns. Standard sorting and filtering apply.

Returns status code

Request url

/campaigns/{id}/contacts?query[email]=@wp.pl&fields=name,email,campaigns&sort[createdOn]=desc&page=4&perPage=30

Request params

Field name

Field type

Field description

query

hash

Used to search only resources that meets criteria. You can specify multiple parameters, then it uses AND logic.

Key	Possible values if fixed
email	*
name	*
createdOn[from]	YYYY-mm-dd
createdOn[to]	YYYY-mm-dd

fields

string

List of fields that should be returned. Id is always returned. Fields should be separated by comma

sort

hash

Enable sorting using specified field (set as a key) and order (set as a value). You can specify multiple fields to sort by.

Key	Possible values if fixed
email	asc,desc
name	asc,desc
createdOn	asc,desc

page

integer

Specify which page of results return.

perPage

integer

Specify how many results per page should be returned

Example Response

[
    {
        "contactId": "8T8HM0",
        "href": "http://api.getresponse.com/v3/contacts/8T8HM0",
        "name": "FT-3 Person",
        "email": "michal+friend3@giergielewicz.pl",
        "note": null,
        "origin": "landing_page",
        "dayOfCycle": null,
        "createdOn": "2015-01-29 12:40:12",
        "changedOn": null,
        "campaign": {
            "campaignId": "o5lx",
            "name": "michalgiergielewicz",
            "href": "http://api.getresponse.com/v3/campaigns/o5lx"
        },
        "timeZone": "Europe/Warsaw",
        "ipAddress": "89.206.36.193",
        "activities": "http://api.getresponse.com/v3/contacts/8T8HM0/activities"
    }
]

This request allows to fetch blacklist for given campaign. Blacklist is simple plain collection of email addresses or partial masks (like @gmail.com).

Returns status code

Request url

/campaigns/{id}/blacklists?query[mask]=@gmail.com

Request params

Field name	Field type	Field description
mask	string	Blacklist mask to search for

Example Response

{
    "masks": [
        "@gmail.com",
        "test@qqmail.com"
    ]
}

This request allows to update blacklist. You need to send full list. We just replace current content with whatever you will send in this request.

Returns status code

Example Response

{
    "masks": [
        "@gmail.com",
        "test@qqmail.com"
    ]
}

Returns the number of all, added, and removed subscribers, grouped by default or by time period.

Returns status code

Request url

/campaigns/statistics/list-size?query[campaignId]=o5lx

Request params

Field name

Field type

Field description

query^(required)

hash

Used to search only resources that meets criteria. You can specify multiple parameters, then it uses AND logic. CampaignId id required

Key	Possible values if fixed
campaignId	*
groupBy	hour,day,month,total
createdOn[from]	YYYY-mm-dd
createdOn[to]	YYYY-mm-dd

fields

string

List of fields that should be returned. Id is always returned. Fields should be separated by comma

Example Response

[
    {
        "totalSubscribers": 0,
        "addedSubscribers": 0,
        "removedSubscribers": 0,
        "createdOn": "2014-03-24"
    },
    {
        "totalSubscribers": 0,
        "addedSubscribers": 0,
        "removedSubscribers": 0,
        "createdOn": "2014-03-25"
    }
]

Returns subscriber locations.

Returns status code

Request url

/campaigns/statistics/locations?query[campaignId]=V

Request params

Field name

Field type

Field description

query^(required)

hash

Used to search only resources that meets criteria. You can specify multiple parameters, then it uses AND logic. CampaignId id required

Key	Possible values if fixed
campaignId	*
createdOn[from]	YYYY-mm-dd
createdOn[to]	YYYY-mm-dd

fields

string

List of fields that should be returned. Id is always returned. Fields should be separated by comma

Example Response

[
    {
        "others": {
            "amount": "68855",
            "continentCode": "",
            "countryCode": ""
        },
        "PL": {
            "amount": "45153",
            "continentCode": "EU",
            "countryCode": "PL"
        }
    }
]

Returns the number and origins of subscriptions, aggregated from specified campaigns, for each day in which any changes were made.

Returns status code

Request url

/campaigns/statistics/origins?query[campaignId]=V,p

Request params

Field name

Field type

Field description

query^(required)

hash

Used to search only resources that meets criteria. You can specify multiple parameters, then it uses AND logic. CampaignId id required

Key	Possible values if fixed
campaignId	*
groupBy	hour,day,month,total
createdOn[from]	YYYY-mm-dd
createdOn[to]	YYYY-mm-dd

fields

string

List of fields that should be returned. Id is always returned. Fields should be separated by comma

Example Response

[
    {
        "2014-12-15": {
            "import": 19,
            "email": 18,
            "www": 19,
            "panel": 19,
            "leads": 6,
            "sale": 6,
            "api": 9,
            "forward": 25,
            "survey": 14,
            "iphone": 22,
            "copy": 17,
            "landing_page": 11,
            "summary": 192
        },
        "2015-01-01": {
            "import": 120,
            "email": 126,
            "www": 122,
            "panel": 108,
            "leads": 105,
            "sale": 105,
            "api": 138,
            "forward": 127,
            "survey": 107,
            "iphone": 123,
            "copy": 120,
            "landing_page": 118,
            "summary": 1444
        },
        "2015-02-01": {
            "import": 112,
            "email": 108,
            "www": 86,
            "panel": 114,
            "leads": 111,
            "sale": 111,
            "api": 122,
            "forward": 96,
            "survey": 123,
            "mobile": 133,
            "copy": 110,
            "landing_page": 95,
            "summary": 1340
        },
        "2015-03-01": {
            "import": 36,
            "email": 46,
            "www": 52,
            "panel": 34,
            "leads": 47,
            "sale": 47,
            "api": 54,
            "forward": 50,
            "survey": 40,
            "mobile": 63,
            "copy": 36,
            "landing_page": 42,
            "summary": 532
        }
    }
]

Returns the number of and reasons for removals.

Returns status code

Request url

/campaigns/statistics/removals?query[campaignId]=V,p

Request params

Field name

Field type

Field description

query^(required)

hash

Used to search only resources that meets criteria. You can specify multiple parameters, then it uses AND logic. CampaignId id required

Key	Possible values if fixed
campaignId	*
groupBy	hour,day,month,total
createdOn[from]	YYYY-mm-dd
createdOn[to]	YYYY-mm-dd

fields

string

List of fields that should be returned. Id is always returned. Fields should be separated by comma

Example Response

[
    {
        "2014-12-05": {
            "user": 5
        },
        "2015-01-21": {
            "user": 10
        },
        "2015-01-22": {
            "user": 12,
            "bounce": 2
        },
        "2015-01-26": {
            "user": 10
        },
        "2015-01-29": {
            "unsubscribe": 2,
            "user": 4
        }
    }
]

Returns the number and origins of subscriptions, grouped by specified campaigns, for each day in which any changes were made.

Returns status code

Request url

/campaigns/statistics/subscriptions?query[campaignId]=Vg745,05lx

Request params

Field name

Field type

Field description

query^(required)

hash

Used to search only resources that meets criteria. You can specify multiple parameters, then it uses AND logic. CampaignId id required

Key	Possible values if fixed
campaignId	*
groupBy	hour,day,month,total
createdOn[from]	YYYY-mm-dd
createdOn[to]	YYYY-mm-dd

fields

string

List of fields that should be returned. Id is always returned. Fields should be separated by comma

Example Response

[
    {
        "2014-12-15": {
            "V": {
                "import": 10,
                "email": 11,
                "www": 10,
                "panel": 14,
                "leads": 3,
                "sale": 3,
                "api": 1,
                "forward": 15,
                "survey": 6,
                "mobile": 12,
                "copy": 7,
                "landing_page": 4,
                "summary": 99
            },
            "p": {
                "import": 9,
                "email": 7,
                "www": 9,
                "panel": 5,
                "leads": 3,
                "sale": 3,
                "api": 8,
                "forward": 10,
                "survey": 8,
                "mobile": 10,
                "copy": 10,
                "landing_page": 7,
                "summary": 93
            }
        },
        "2015-01-01": {
            "p": {
                "import": 58,
                "email": 61,
                "www": 67,
                "panel": 58,
                "leads": 49,
                "sale": 49,
                "api": 63,
                "forward": 67,
                "survey": 51,
                "mobile": 61,
                "copy": 57,
                "landing_page": 58,
                "summary": 721
            },
            "V": {
                "import": 62,
                "email": 65,
                "www": 55,
                "panel": 50,
                "leads": 56,
                "sale": 56,
                "api": 75,
                "forward": 60,
                "survey": 56,
                "mobile": 62,
                "copy": 63,
                "landing_page": 60,
                "summary": 723
            }
        },
        "2015-02-01": {
            "V": {
                "import": 56,
                "email": 60,
                "www": 33,
                "panel": 56,
                "leads": 56,
                "sale": 56,
                "api": 64,
                "forward": 41,
                "survey": 67,
                "mobile": 65,
                "copy": 65,
                "landing_page": 46,
                "summary": 675
            },
            "p": {
                "import": 56,
                "email": 48,
                "www": 53,
                "panel": 58,
                "leads": 55,
                "sale": 55,
                "api": 58,
                "forward": 55,
                "survey": 56,
                "mobile": 68,
                "copy": 45,
                "landing_page": 49,
                "summary": 665
            }
        },
        "2015-03-01": {
            "p": {
                "import": 19,
                "email": 24,
                "www": 34,
                "panel": 18,
                "leads": 29,
                "sale": 29,
                "api": 34,
                "forward": 23,
                "survey": 18,
                "mobile": 26,
                "copy": 15,
                "landing_page": 25,
                "summary": 274
            },
            "V": {
                "import": 17,
                "email": 22,
                "www": 18,
                "panel": 16,
                "leads": 18,
                "sale": 18,
                "api": 20,
                "forward": 27,
                "survey": 22,
                "mobile": 37,
                "copy": 21,
                "landing_page": 17,
                "summary": 258
            }
        }
    }
]

Returns the balance and source of subscriptions, aggregated from specified campaigns, for each day in which any changes were made.

Returns status code

Request url

/campaigns/statistics/balance?query[campaignId]=Vg745,05lx

Request params

Field name

Field type

Field description

query^(required)

hash

Used to search only resources that meets criteria. You can specify multiple parameters, then it uses AND logic. CampaignId id required

Key	Possible values if fixed
campaignId	*
groupBy	hour,day,month,total
createdOn[from]	YYYY-mm-dd
createdOn[to]	YYYY-mm-dd

fields

string

List of fields that should be returned. Id is always returned. Fields should be separated by comma

Example Response

[
    {
        "2014-12-05": {
            "removals": {
                "user": 5
            },
            "subscriptions": {
                "import": 0,
                "email": 0,
                "www": 0,
                "panel": 0,
                "leads": 0,
                "sale": 0,
                "api": 7,
                "forward": 0,
                "survey": 0,
                "mobile": 0,
                "copy": 0,
                "landing_page": 0,
                "summary": 7
            }
        },
        "2015-01-21": {
            "removals": {
                "user": 10
            }
        },
        "2015-01-22": {
            "removals": {
                "user": 12,
                "bounce": 2
            },
            "subscriptions": {
                "import": 0,
                "email": 0,
                "www": 0,
                "panel": 0,
                "leads": 0,
                "sale": 0,
                "api": 7,
                "forward": 0,
                "survey": 0,
                "mobile": 0,
                "copy": 0,
                "landing_page": 0,
                "summary": 7
            }
        }
    }
]

Returns current basic statistics for campaigns.

Returns status code

Request url

/campaigns/statistics/summary

Request params

Field name

Field type

Field description

query^(required)

hash

Used to search only resources that meets criteria. You can specify multiple parameters, then it uses AND logic.

Key	Possible values if fixed
campaignId	*

fields

string

List of fields that should be returned. Id is always returned. Fields should be separated by comma

Example Response

[
    {
        "o5lx": {
            "totalSubscribers": "4",
            "totalNewsletters": "129",
            "totalTriggers": "0",
            "totalLandingPages": "1",
            "totalWebforms": "3"
        },
        "CC9F": {
            "totalSubscribers": "0",
            "totalNewsletters": "0",
            "totalTriggers": "0",
            "totalLandingPages": "5",
            "totalWebforms": "0"
        },
        "V6OeR": {
            "totalSubscribers": "0",
            "totalNewsletters": "0",
            "totalTriggers": "0",
            "totalLandingPages": "0",
            "totalWebforms": "0"
        }
    }
]

Campaigns (Lists)

Table of Contents

GET /campaigns

Returns status code

Request url

Request params

Example Response

GET /campaigns/{campaignsId}

Returns status code

Request url

Request params

Example Response

POST /campaigns

Returns status code

Example Request Body

Body params

Example Response

Possible Errors

POST /campaigns/{campaignsId}

Returns status code

Example Request Body

Body params

Example Response

Possible Errors

GET /campaigns/{id}/contacts

Returns status code

Request url

Request params

Example Response

GET /campaigns/{id}/blacklists

Returns status code

Request url

Request params

Example Response

POST /campaigns/{id}/blacklists

Returns status code

Example Response

GET /campaigns/statistics/list-size

Returns status code

Request url

Request params

Example Response

GET /campaigns/statistics/locations

Returns status code

Request url

Request params

Example Response

GET /campaigns/statistics/origins

Returns status code

Request url

Request params

Example Response

GET /campaigns/statistics/removals

Returns status code

Request url

Request params

Example Response

GET /campaigns/statistics/subscriptions

Returns status code

Request url

Request params

Example Response

GET /campaigns/statistics/balance

Returns status code

Request url

Request params

Example Response

GET /campaigns/statistics/summary

Returns status code

Request url

Request params

Example Response