RSS Newsletters
GET /rss-newsletters
Returns status code
200
Request url
/rss-newsletters?query[subject]=test&fields=name,status&sort[createdOn]=asc&page=1&perPage=100
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.
| ||||||||||||||||||
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).
| ||||||||||||||||||
perPage | int | Number results on page | ||||||||||||||||||
page | int | Page number |
Example Response
[
{
"rssNewsletterId": "V",
"href": "http://api.getresponse.com/v3/rss-ewsletters/V",
"rssFeedUrl": "http://blog.getresponse.com",
"name": "rsstest0",
"createdOn": "2014-09-29T12:25:52+0000",
"subject": "My rss to newsletters",
"flags": "openrate",
"status": "enabled",
"fromField": {
"fromFieldId": "V",
"href": "http://api.getresponse.com/v3/from-fields/V"
},
"replyTo": {
"fromFieldId": "M",
"href": "http://api.getresponse.com/v3/from-fields/M"
},
"content": {
"html": "",
"plain": ""
},
"sendSettings": {
"frequency": "asap",
"sendAtHour": null,
"sendAtWeekDay": null,
"sendAtMonthDay": null,
"filter": "recent",
"maxArticles": "30",
"selectedCampaigns": [
"V"
],
"selectedSegments": [],
"selectedSuppresions": [],
"excludedCampaigns": [],
"excludedSegments": []
},
"clickTracks": null
}
]
POST /rss-newsletters/
Returns status code
200
Example Request Body
{
"rssFeedUrl": "http://blog.getresponse.com",
"name": "rsstest0",
"subject": "My rss to newsletter",
"flags": [
"openrate"
],
"status": "enabled",
"fromField": {
"fromFieldId": "V"
},
"replyTo": {
"fromFieldId": "M"
},
"content": {
"html": "test of html content",
"plain": "other content"
},
"sendSettings": {
"frequency": "asap",
"sendAtHour": null,
"sendAtWeekDay": null,
"sendAtMonthDay": null,
"filter": "recent",
"maxArticles": "30",
"selectedCampaigns": [
"V"
],
"selectedSegments": [],
"selectedSuppressions": [],
"excludedCampaigns": [],
"excludedSegments": []
}
}
Body params
Field name | Field type | Field description | ||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
rssFeedUrl (required) | string | Url with RSS Feed | ||||||||||||||||||||||||||||||||||||
name | string | How your newsletters will be seen in panel (length: 1-255) | ||||||||||||||||||||||||||||||||||||
subject (required) | string | Message subject (length: 1-255) | ||||||||||||||||||||||||||||||||||||
flags | set | Message flags. Allowed values: openrate, clicktrack and google_analytics | ||||||||||||||||||||||||||||||||||||
status (required) | string | Message status enabled|disabled | ||||||||||||||||||||||||||||||||||||
editor | string | How message was created: 'custom' - custom made message,'plain' - plain content,'getresponse' - via gr editor] | ||||||||||||||||||||||||||||||||||||
fromfield (required) | object | Message from email
| ||||||||||||||||||||||||||||||||||||
fromfield | object | Reply to email
| ||||||||||||||||||||||||||||||||||||
content (required) | collection | Message contents
| ||||||||||||||||||||||||||||||||||||
sendSettings | collection | How message will be delivered to subscriber
|
Example Response
{
"rssNewsletterId": "V",
"href": "http://api.getresponse.com/v3/rss-newsletters/V",
"rssFeedUrl": "http://blog.getresponse.com",
"name": "rsstest0",
"createdOn": "2014-09-29T12:25:52+0000",
"subject": "My rss to newsletter",
"flags": "openrate",
"status": "enabled",
"fromField": {
"fromFieldId": "V",
"href": "http://api.getresponse.com/v3/from-fields/V"
},
"replyTo": {
"fromFieldId": "M",
"href": "http://api.getresponse.com/v3/from-fields/M"
},
"content": {
"html": "test0",
"plain": null
},
"sendSettings": {
"frequency": "asap",
"sendAt": null,
"filter": "recent",
"maxArticles": "30",
"selectedCampaigns": [
"V"
],
"selectedSegments": [],
"selectedSuppressions": [],
"excludedCampaigns": [],
"excludedSegments": []
},
"clickTracks": []
}
Possible Errors
GET /rss-newsletters/{newsletterId}
Returns status code
200
Example Response
{
"rssNewsletterId": "V",
"href": "http://api.getresponse.com/v3/rss-newsletters/V",
"rssFeedUrl": "http://blog.getresponse.com",
"name": "rsstest0",
"createdOn": "2014-09-29T12:25:52+0000",
"subject": "My rss to newsletter",
"flags": "openrate",
"status": "enabled",
"fromField": {
"fromFieldId": "V",
"href": "http://api.getresponse.com/v3/from-fields/V"
},
"replyTo": {
"fromFieldId": "M",
"href": "http://api.getresponse.com/v3/from-fields/M"
},
"content": {
"html": "test0",
"plain": null
},
"sendSettings": {
"frequency": "asap",
"sendAtHour": null,
"sendAtWeekDay": null,
"sendAtMonthDay": null,
"filter": "recent",
"maxArticles": "30",
"selectedCampaigns": [
"V"
],
"selectedSegments": [],
"selectedSuppresions": [],
"excludedCampaigns": [],
"excludedSegments": []
},
"clickTracks": []
}
DELETE /rss-newsletters/{rssNewsletterId}
Returns status code
204
POST /rss-newsletters/{rssNewsletterId}
Returns status code
200
Example Request Body
{
"rssFeedUrl": "http://blog.getresponse.com",
"name": "rsstest0",
"subject": "My rss to newsletter",
"flags": "openrate",
"status": "enabled",
"fromField": {
"fromFieldId": "V"
},
"replyTo": {
"fromFieldId": "M"
},
"content": {
"html": "test of html content",
"plain": "other content"
},
"sendSettings": {
"frequency": "asap",
"sendAtHour": null,
"sendAtWeekDay": null,
"sendAtMonthDay": null,
"filter": "recent",
"maxArticles": "30",
"selectedCampaigns": [
"V"
],
"selectedSegments": [],
"selectedSuppressions": [],
"excludedCampaigns": [],
"excludedSegments": []
}
}
Body params
Field name | Field type | Field description | ||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
rssFeedUrl (required) | string | Url with RSS Feed | ||||||||||||||||||||||||||||||||||||
name | string | How your newsletters will be seen in panel, (length: 1-255) | ||||||||||||||||||||||||||||||||||||
subject (required) | string | Message subject, (length: 1-255) | ||||||||||||||||||||||||||||||||||||
flags | set | Message flags. Allowed values: openrate, clicktrack and google_analytics | ||||||||||||||||||||||||||||||||||||
status (required) | string | Message status enabled|disabled | ||||||||||||||||||||||||||||||||||||
editor | string | How message was created: 'custom' - custom made message,'plain' - plain content,'getresponse' - via gr editor] | ||||||||||||||||||||||||||||||||||||
fromfield (required) | object | Message from email
| ||||||||||||||||||||||||||||||||||||
fromfield | object | Reply to email
| ||||||||||||||||||||||||||||||||||||
content (required) | collection | Message contents
| ||||||||||||||||||||||||||||||||||||
sendSettings | collection | How message will be delivered to subscriber
|
Example Response
{
"rssNewsletterId": "V",
"href": "http://api.getresponse.com/v3/rss-newsletters/V",
"rssFeedUrl": "http://blog.getresponse.com",
"name": "rsstest0",
"createdOn": "2014-09-29T12:25:52+0000",
"subject": "My rss to newsletter",
"flags": "openrate",
"status": "enabled",
"fromField": {
"fromFieldId": "V",
"href": "http://api.getresponse.com/v3/from-fields/V"
},
"replyTo": {
"fromFieldId": "M",
"href": "http://api.getresponse.com/v3/from-fields/M"
},
"content": {
"html": "test0",
"plain": null
},
"sendSettings": {
"frequency": "asap",
"sendAt": null,
"filter": "recent",
"maxArticles": "30",
"selectedCampaigns": [
"V"
],
"selectedSegments": [],
"selectedSuppressions": [],
"excludedCampaigns": [],
"excludedSegments": []
},
"clickTracks": []
}
GET rss-newsletters/statistics/
Returns status code
200
Request url
rss-newsletters/statistics?query[rssNewsletterId]=1,2?page=1&perPage=100
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. At least one of following is required: campaignId, rssNewsletterId
| ||||||||||||||||||
fields | string | List of fields that should be returned. Id is always returned. Fields should be separated by comma | ||||||||||||||||||
page | integer | Specify which page of results return. | ||||||||||||||||||
perPage | integer | Specify how many results per page should be returned |
Example Response
[
{
"timeInterval": "2014-09-20T00:00:00+0000/P2M18DT10H0M0S",
"sent": "2",
"totalOpened": "4",
"uniqueOpened": "6",
"totalClicked": "2",
"uniqueClicked": "0",
"goals": "0",
"uniqueGoals": "0",
"forwarded": "0",
"unsubsribed": "0",
"bounced": "0",
"complaints": "0"
}
]
GET /rss-newsletters/{id}/statistics
Returns status code
200
Request url
/rss-newsletters/V/statistics?query[groupBy]=day&page=1&perPage=100
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.
| ||||||||||||
fields | string | List of fields that should be returned. Id is always returned. Fields should be separated by comma | ||||||||||||
page | integer | Specify which page of results return. | ||||||||||||
perPage | integer | Specify how many results per page should be returned |
Example Response
[
{
"timeInterval": "2014-09-20T00:00:00+0000/P2M18DT10H0M0S",
"sent": "2",
"totalOpened": "4",
"uniqueOpened": "6",
"totalClicked": "2",
"uniqueClicked": "0",
"goals": "0",
"uniqueGoals": "0",
"forwarded": "0",
"unsubsribed": "0",
"bounced": "0",
"complaints": "0"
}
]