Opens Aggregated

The opens object gives you information about how many times a specific user has opened your mail.

---

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

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

---

Example aggregated opens

{
    "unique": [
        {
            "count": 80,
            "start": "2014-07-29T11:32:52Z",
            "end": "2014-08-01T18:59:00.405Z"
        },
        ...
    ],
    "total": [
        {
            "count": 150,
            "start": "2014-07-29T11:32:52Z",
            "end": "2014-08-01T18:59:00.405Z"
        },
        ...
    ],
    "clicks": [
        {
            "count": 179,
            "start": "2014-07-29T11:32:52Z",
            "end": "2014-08-01T18:59:00.405Z"
        },
        ...
    ]
}

---

GET /reports/<report_id>/opens/aggregated/

Responds with an object with 3 properties:

• unique: the unique opens
• total: the total number of opens and
• clicks: the unique number of clicks

Each one of them is a list of 20 objects - the whole interval split into 20 equal time interval, with 3 properties:

• count: the number of opens/clicks for the period
• start: the start of the period
• end: the end of the period

Possible url parameters are:

• start: <datetime> - the start time of the interval
• end: <datetime> - the end time of the interval
• first_24h: - lists the data for the first 24 hours after the newsletter was sent
• all_time: - lists the data for the period from the sending to the last activity

Example:

GET /reports/123/opens/aggregated/
{
    "unique": [
        {
            "count": 80,
            "start": "2014-07-29T11:32:52Z",
            "end": "2014-08-01T18:59:00.405Z"
        },
        ...
    ],
    "total": [
        {
            "count": 150,
            "start": "2014-07-29T11:32:52Z",
            "end": "2014-08-01T18:59:00.405Z"
        },
        ...
    ],
    "clicks": [
        {
            "count": 179,
            "start": "2014-07-29T11:32:52Z",
            "end": "2014-08-01T18:59:00.405Z"
        },
        ...
    ]
}