Reports

The reports object give you the ability to track your newsletters. You can – for example – see how many subscribers opened your newsletter and which links they clicked.

---

Renders: [application/json, text/html, application/xml]

Parsers: [application/json, application/x-www-form-urlencoded, multipart/form-data]

---

Readonly fields

• links_url
• bounced_temporary
• bounced_permanent
• sender_email
• unsubscribed_url
• opens_url
• receivers_who_clicked_24h
• mail_subject
• preview_url
• mail_id
• url
• sendtime
• sender_name
• unique_html_clicks
• receivers_who_clicked
• complained
• get_view_online_link
• bounces_url
• mail_url
• id
• sent
• sent_to_lists

Example report

{
    "id": 4
    "url": "https://api.getanewsletter.com/v3/reports/4/",
    "sent_to": 300,
    "sent_to_lists": [
        "My list"
    ],
    "sent": "2014-08-29T13:59:49Z",
    "sendtime": "-",
    "delivered": 295,
    "total_html_opened": 285
    "unique_html_opened": 285,
    "html_clicks": 175,
    "unsubscribed": 2,
    "bounced": 5,
    "type": 0,
    "finished": "2013-08-24T13:20:40.299Z",
    "preview_url": "http://admin.getanewsletter.com/t/pm/83748573/",
    "bounces_url": "https://api.getanewsletter.com/v3/reports/4/bounces/",
    "unsubscribed_url": "https://api.getanewsletter.com/v3/reports/4/unsubscribed/",
    "links_url": "https://api.getanewsletter.com/v3/reports/4/links/",
    "opens_url": "https://api.getanewsletter.com/v3/reports/4/openuniques/",
    "mail_id": 330517,
    "mail_url": "https://api.getanewsletter.com/v3/mails/sent/330517/",
    "mail_subject": "My Newsletter",
    "sender_name": "John Doe",
    "sender_email": "john.doe@example.com",
    "unique_html_clicks": 98,
    "receivers_who_clicked": 0,
    "receivers_who_clicked_24h": 0,
    "complained": 0,
    "bounced_permanent": 0,
    "bounced_temporary": 0,
    "get_view_online_link": "http://admin.getanewsletter.com/t/pm/83748573/"
}

---

GET /reports/

Responds with a list of attributes, like usual we provide next, prev, count and the results

Possible url parameters are:

• page: <int>

Example:

{
    "count": 46,
    "next": "https://api.getanewsletter.com/v3/reports/?page=3,
    "previous": "https://api.getanewsletter.com/v3/reports/?page=2,
    "results": [
        {
            "id": 6,
            "url": "https://api.getanewsletter.com/v3/reports/6/",
            "mail_id": 185,
            "mail_subject": "Mail subject 185",
            "sent": "2014-06-18T09:01:45Z",
            "sendtime": "-",
            "sent_to_lists": [
                "My list"
            ],
            "sent_to": 300,
            "total_html_opened": 120
        },
        ...
    ]
}

---

GET /reports/<id>/

Responds with a report.

Example:

GET  '/reports/6/
{
    "id": 4
    "url": "https://api.getanewsletter.com/v3/reports/4/",
    "sent_to": 300,
    "sent_to_lists": [
        "My list"
    ],
    "sent": "2014-08-29T13:59:49Z",
    "sendtime": "-",
    "delivered": 295,
    "total_html_opened": 285
    "unique_html_opened": 285,
    "html_clicks": 175,
    "unsubscribed": 2,
    "bounced": 5,
    "type": 0,
    "finished": "2013-08-24T13:20:40.299Z",
    "preview_url": "http://admin.getanewsletter.com/t/pm/83748573/",
    "bounces_url": "https://api.getanewsletter.com/v3/reports/4/bounces/",
    "unsubscribed_url": "https://api.getanewsletter.com/v3/reports/4/unsubscribed/",
    "links_url": "https://api.getanewsletter.com/v3/reports/4/links/",
    "opens_url": "https://api.getanewsletter.com/v3/reports/4/openuniques/",
    "mail_id": 330517,
    "mail_url": "https://api.getanewsletter.com/v3/mails/sent/330517/",
    "mail_subject": "My Newsletter",
    "sender_name": "John Doe",
    "sender_email": "john.doe@example.com",
    "unique_html_clicks": 98,
    "receivers_who_clicked": 0,
    "receivers_who_clicked_24h": 0,
    "complained": 0,
    "bounced_permanent": 0,
    "bounced_temporary": 0,
    "get_view_online_link": "http://admin.getanewsletter.com/t/pm/83748573/"
}