email - getallclicks

API Call Information

area: email

action: getallclicks

API Arguments

Argument	Data Type	Required	Description
`datestart`	string	No	Start date takes a date or a unixtimestamp
`dateend`	string	No	End date takes a date or a unixtimestamp
`campaign`	integer	No	Filter by a campaign id
`unique`	boolean either 1 or 0	No	If this is set only unique records will be shown
`nolimit`	boolean either 1 or 0	No	if this is set no limit on number of records
`start`	integer	No	Starting position
`limit`	integer	No	Number of records to return
`showcustomfields`	boolean either 1 or 0	No	Returns all the custom columns in the list. Faster if turned off. Default is enabled.

API URL Example

https://api.hypermail.com/api.php?apikey=YOURAPIKEYHERE&area=email&action=getallclicks

API Response

XML Response

<response>

<log>

<id>4667

</id>

<email>test@test.com

</email>

<date>April 04, 2020, 01:20 am

</date>

<link>

<![CDATA[https://www.eventbrite.com/]]>

</link>

<ip>34.229.6.24

</ip>

<campaignid>2119804

</campaignid>

</log>

</response>

JSON Response

{
    "log": {
        "id": "4667",
        "email": "test@test.com",
        "date": "April 04, 2020, 01:20 am",
        "link": "https://www.eventbrite.com/",
        "ip": "34.229.6.24",
        "campaignid": "2119804"
    }
}