Last Update: 2024-03-21

Get newsletter statistics

Request:

<getnewsletterstatistics key="Email">
  <datefrom>YYYY-mm-dd</datefrom>
  <datetill>YYYY-mm-dd</datetill>
  <page>1</page>
  <pagesize>1000</pagesize>
</getnewsletterstatistics>
Description of XML-Tags:
Element Format Description
getnewsletterstatistics["key"] varchar(30) Determines which field of each address-record is returned. If "key" is not specified, default-key is email.
getnewsletterstatistics->datefrom YYYY-mm-dd Beginning of the desired date range
getnewsletterstatistics->datetill YYYY-mm-dd Optional; End of the desired date range. If not specified, the current date will be set.
getnewsletterstatistics->page Optional; Request a specific page of the result-set (Default=1)
getnewsletterstatistics->pagesize Optional; Defines the number of returned records (Default=1000)

Response:

<addresses>
  <address key="Email">
    <nlid></nlid>
    <statid></statid>
    <p></p>
    <bouncecode></bouncecode>
    <bouncecount></bouncecount>
    <viewed></viewed>
    <articles>
      <id></id>
      ...
    </articles>
    <links>
      <id></id>
      ...
    </links>
  </address>
  ...
</addresses>
<newsletters>
  <newsletter>
    <title></title>
    <titleinternal></titleinternal>
    <senddatetime>YYYY-mm-dd HH:ii:ss</senddatetime>
    <type></type>
    <previewurl></previewurl>
  </newsletter>
  ...
</newsletters>
<bouncecodes>
  <bouncecode code=""></bouncecode>
  ...
</bouncecodes>
<articles>
  <article id="">
    <title></title>
  </article>
  ...
</articles>
<links>
  <link id="">
    <url></url>
  </link>
  ...
</links>
Description of XML-Tags:
Element Format Description
addresses List of all addresses with statistic data of the specified date range
addresses->address Container element of one address
addresses->address["key"] varchar(255) The address identifier; The field which was defined the request addresslistadd->addresses["key"]
addresses->address->nlid int(10) ID of the sent newsletter; More info about this newsletter can be found here: newsletters->newsletter[id="..."]
addresses->address->statid int(10) ID of the statistic record
addresses->address->p varchar(255)
addresses->address->bouncecode 3-digit Set to "0" if newsletter was sent successfully, otherwise the bouncecode; Description of the code can be found here: bouncecodes->bouncecode[code="..."]
addresses->address->bouncecount varchar(255)
addresses->address->viewed 1|0 1..Viewed, 0..Not viewed
addresses->address->articles List of all clicked articles
addresses->address->articles->id int(10) ID of clicked article; More info about this article can be found here: articles->article[id="..."]
addresses->address->links List of all clicked links
addresses->address->links->id int(10) ID of clicked link; More info about this link can be found here: links->link[id="..."]
newsletters List of all newsletters with detail information
newsletters->newsletter Container element of one newsletter
newsletters->newsletter->title varchar(255) Newsletter title
newsletters->newsletter->titleinternal varchar(255) Newsletter internal title
newsletters->newsletter->senddatetime YYYY-mm-dd HH:ii:ss Date and time when the newsletter was sent
newsletters->newsletter->type varchar(255) Type of the newsletter
newsletters->newsletter->previewurl varchar(255) Base URL of the preview link where addresses->address->p needs to be appended for the personalized preview link
bouncecodes List of all bouncecodes with description
bouncecodes->bouncecode Description for the bouncecode
articles List of all articles with detail information
articles->article Container element of one article
articles->article->title varchar(255) Article title
links List of all links with detail information
links->link Container element of one link
links->link->url varchar(255) Link URL
Für Rückfragen stehen wir Ihnen jederzeit gerne unter support@eyepin.com zur Verfügung.