Clicks

The clicks object gives you information about how many times each contact has clicked on a specific link.


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

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


Readonly fields

  • first_click
  • last_click
  • url
  • contact
  • contact_url
  • total_clicks

Example click

{
    "url": "https://api.getanewsletter.com/v3/reports/123/links/23/clicks/5/",
    "contact": "john.doe@example.com",
    "contact_url": "https://api.getanewsletter.com/v3/contacts/john.doe@example.com/",
    "first_click": "2013-08-24T14:58:06.870Z",
    "last_click": "2013-08-27T14:58:06.870Z",
    "total_clicks": 9
}

Responds with a list of clicks, 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/123/links/23/clicks/?page=3,
    "previous": "https://api.getanewsletter.com/v3/reports/123/links/23/clicks/?page=2,
    "results": [
        {
            "url": "https://api.getanewsletter.com/v3/reports/123/links/23/clicks/5/",
            "contact": "john.doe@example.com",
            "contact_url": "https://api.getanewsletter.com/v3/contacts/john.doe@example.com/",
            "first_click": "2013-08-24T14:58:06.870Z",
            "last_click": "2013-08-27T14:58:06.870Z",
            "total_clicks": 9
        },
        ...
    ]
}

Responds with a report.

Example:

GET /reports/123/links/23/clicks/5/
{
    "url": "https://api.getanewsletter.com/v3/reports/123/links/23/clicks/5/",
    "contact": "john.doe@example.com",
    "contact_url": "https://api.getanewsletter.com/v3/contacts/john.doe@example.com/",
    "first_click": "2013-08-24T14:58:06.870Z",
    "last_click": "2013-08-27T14:58:06.870Z",
    "total_clicks": 9
}