Last Update: 2024-03-21
<?xml version="1.0" encoding="utf-8"?> <getnewsletterreport id="" customerid="" />
| Element | Format | Description |
|---|---|---|
| getnewsletterreport | ||
| ↳ @id | int | ID of desired newsletter |
| ↳ @customerid | int | Optional; ID of customer where newsletter is from (needs API username/password of Suite-Manager). |
<data>
<Planned>1000</Planned>
<Bounced>10</Bounced>
<Queued>0</Queued>
<Resending>10</Resending>
<Sent>980</Sent>
<ViewsUnique>400</ViewsUnique>
<ViewsTotal>600</ViewsTotal>
<ClicksUnique>100</ClicksUnique>
<ClicksTotal>150</ClicksTotal>
<SignOut>0</SignOut>
<TellFriend>10</TellFriend>
<DeliveryRate>99</DeliveryRate>
<BounceRate>1</BounceRate>
<ViewRate>40</ViewRate>
<ClickRate>25</ClickRate>
<UnsubscribeRate>0</UnsubscribeRate>
<links>
<newsletter>
<link id="_____" source="Link">
<Url><![CDATA[https://_____]]></Url>
<Title><![CDATA[_____]]></Title>
<ClicksUnique>_____</ClicksUnique>
<ClicksTotal>_____</ClicksTotal>
<ClickRate>_____</ClickRate>
</link>
...
</newsletter>
<contents>
<content id="_____" source="_____" area="_____" group="_____" pos="_____">
<title><![CDATA[_____]]></title>
<Filter id="_____">
<Match>_____</Match>
<Name><![CDATA[_____]]></Name>
<Delivered>_____</Delivered>
<ViewsUnique>_____</ViewsUnique>
</Filter>
<Topics>
<IDs>_____</IDs>
<Delivered>_____</Delivered>
<ViewsUnique>_____</ViewsUnique>
</Topics>
<links>
<link id="_____" source="_____">
<Url><![CDATA[https://_____]]></Url>
<Title><![CDATA[_____]]></Title>
<ClicksUnique>_____</ClicksUnique>
<ClicksTotal>_____</ClicksTotal>
<ClickRate>_____</ClickRate>
</link>
...
</links>
</content>
...
</contents>
<template>
<link id="_____" source="Link">
<Url><![CDATA[https://_____]]></Url>
<Title><![CDATA[_____]]></Title>
<ClicksUnique>_____</ClicksUnique>
<ClicksTotal>_____</ClicksTotal>
<ClickRate>_____</ClickRate>
</link>
...
</template>
</links>
</data>
| Element | Format | Description |
|---|---|---|
| data | ||
| ↳ Planned | int | Number of planned users |
| ↳ Bounced | int | Number of users where a bounce was returned |
| ↳ Queued | int | Number of mails which are still queued for sending |
| ↳ Resending | int | Number of mails where a first delivery attempt failed |
| ↳ Sent | int | Number of mails that were successfully delivered |
| ↳ ViewsUnique | int | Number of different (unique) persons that opened the newsletter |
| ↳ ViewsTotal | int | Total number of newsletter opens (all views of all persons) |
| ↳ ClicksUnique | int | Number of different (unique) persons that clicked a link in the newsletter |
| ↳ ClicksTotal | int | Total number of all clicks of all persons |
| ↳ SignOut | int | Number of users who unsubscribed from the newsletter |
| ↳ TellFriend | int | Number of users who forwared the newsletter |
| ↳ DeliveryRate | percent | Delivery rate |
| ↳ BounceRate | percent | Bouce rate |
| ↳ ViewRate | percent | View rate |
| ↳ ClickRate | percent | Click rate |
| ↳ UnsubscribeRate | percentUnsubscribe rate | |
| ↳ links | report of clicked links | |
| ↳ newsletter | List of links in newsletter fields like editorial, footer, ... | |
| ↳ link | ||
| ↳ link[id] | int | ID of link |
| ↳ link[source] | int | Source of link |
| ↳ Url | Url of link | |
| ↳ Title | Title of link (same as Url or a name if special link like "Confirm subscribription") | |
| ↳ ClicksUnique | int | Unique clicks of link (number of different persons) |
| ↳ ClicksTotal | int | Total clicks of link (total clicks of all persons) |
| ↳ ClickRate | percent | Click rate |
| ↳ contents | List of contents in newsletter | |
| ↳ content | ||
| ↳ content[id] | int | ID of content |
| ↳ content[source] | Source of content. Types:
| |
| ↳ content[area] | int | Area number of content in template |
| ↳ content[group] | int | Group number of content in area in template (0 if there's no grouping) |
| ↳ content[grouptitle] | int | Group title |
| ↳ content[pos] | int | Position of content in area (or group if there are groups) |
| ↳ title | text | Title of content |
| ↳ Filter | Is content only showen if user is included or excluded in given filter? | |
| ↳ Filter[id] | ID of filter | |
| ↳ Match | 0|1 | 0 ... user is excluded in filter 1 ... user is included in filter |
| ↳ Name | Name of filter | |
| ↳ Delivered | int | Number of users who got this content delivered |
| ↳ ViewsUnique | int | Number of users who got this content also viewed the newsletter |
| ↳ Topics | Does this content has topics assigned? | |
| ↳ IDs | Comma separated topic ids | |
| ↳ Delivered | int | Number of users who had subscribed one of the given topics and therefor got this content delivered |
| ↳ ViewsUnique | int | Number of users who got this content also viewed the newsletter |
| ↳ links | List of links in content | |
| ↳ link | ||
| ↳ link[id] | int | ID of link |
| ↳ link[source] | int | Source of link |
| ↳ Url | Url of link | |
| ↳ Title | Title of link (same as Url or a name if special link like "Confirm subscribription") | |
| ↳ ClicksUnique | int | Unique clicks of link (number of different persons) |
| ↳ ClicksTotal | int | Total clicks of link (total clicks of all persons) |
| ↳ ClickRate | percent | Click rate |
| ↳ template | List of fixed links in used template | |
| ↳ link | ||
| ↳ link[id] | int | ID of link |
| ↳ link[source] | int | Source of link |
| ↳ Url | Url of link | |
| ↳ Title | Title of link (same as Url or a name if special link like "Confirm subscribription") | |
| ↳ ClicksUnique | int | Unique clicks of link (number of different persons) |
| ↳ ClicksTotal | int | Total clicks of link (total clicks of all persons) |
| ↳ ClickRate | percent | Click rate |