Click Report

This method generates click reports.

info

If you do not specify a date range, only the reports from the last 24 hours will be generated.

This is a GET method.

REST WADL

https://atmp-pub-api-www3.actito.com/apinmpreporting/application.wadl

REST URL

https://atmp-pub-api-www3.actito.com/apinmpreporting/report/click?beginDate={beginDate}&endDate={endDate}

| Input parameters
Required parameters | Description | Output parameters | Description | | ----------------------------------------------------------------------------- | ----------- | ----------------- | ----------- | | token | (missing or bad snippet) | return | A click report is generated, otherwise an error code appears. | | beginDate | (missing or bad snippet) | | | | endDate | (missing or bad snippet) | | |

Error Descriptions

Status Code	Error Code	Error messages	Example Error Output
403		Access denied. You must fill in the managerKey parameter to authentificate on this API You must fill in the password paramter to authentificate on this API. Please enter a valid token to validate your connection. Your session has expired due to timeout	<?xml version="1.0" encoding="UTF-8" standalone="yes"?><ExceptionEntity><errorMessage>Access denied.</errorMessage></ExceptionEntity>
404	API_209	No result found	<?xml version="1.0" encoding="UTF-8" standalone="yes"?><ExceptionEntity><errorCode>API_209</errorCode><errorMessage>No result found</errorMessage></ExceptionEntity>

REST Example

Input

XML Input

URL

https://atmp-pub-api-www3.actito.com/apinmpreporting/report/click?beginDate=2018-04-11T20%3A22%3A06%2B02%3A00&endDate=2019-04-12T20%3A22%3A06%2B02%3A00

Header

{token}
content-type application/xml
accept application/xml

JSON Input

URL

https://atmp-pub-api-www3.actito.com/apinmpreporting/report/click?beginDate=2018-04-11T20%3A22%3A06%2B02%3A00&endDate=2019-04-12T20%3A22%3A06%2B02%3A00

Header

{token}
content-type application/json
accept application/json

Output

XML Output

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<report>
    <click>
        <nmMessageId>45693</nmMessageId>
        <memberUID>59BCDC04000106AD</memberUID>
        <name>nmp_content_test_msg</name>
        <email>xxx@xxxx.com</email>
        <clickDate>2018-08-13T12:58:33+01:00</clickDate>
        <linkName>Users link</linkName>
        <linkType>DYNAMIC_TRACKING</linkType>
        <url>http://google.fr</url>
    </click>
    <click>
        <nmMessageId>45696</nmMessageId>
        <memberUID>FC54ACE86E02000F</memberUID>
        <name>nmp_content_pre_demo</name>
        <email>xxx@yyyy.com</email>
        <clickDate>2018-08-13T10:15:47+01:00</clickDate>
        <linkName>Users link</linkName>
        <linkType>DYNAMIC_TRACKING</linkType>
        <url>http://www.yahoo.fr</url>
    </click>
</report>

JSON Output

{
       "click":
       [
           {
               "nmMessageId": 45693,
               "memberUID": "59BCDC04000106AD",
               "name": "nmp_content_test_msg",
               "email": "xxx@xxxx.com",
               "clickDate": "2018-08-13T12:58:33+01:00",
               "linkName": "Users link",
               "linkType": DYNAMIC_TRACKING,
               "url": "http://google.fr"
           },
           {
               "nmMessageId": 45696,
               "memberUID": "FC54ACE86E02000F",
               "name": "nmp_content_pre_demo",
               "email": "xxxx@yyyy.com",
               "clickDate": "2018-08-13T10:15:47+01:00",
               "linkName": "Users link",
               "linkType": DYNAMIC_TRACKING,
               "url": "http://www.yahoo.fr"
           }
       ]
    }

Link Type Descriptions

LinkType	Description
STANDARD	A standard link.
PERSONALIZABLE	A personalized link.
MIRROR	A mirror link.
DYNAMIC_TRACKING	A link that is both personalized and tracked.
WEBBUG	A link showing if a message is opened.
SMTP_HEADER_UNSUBSCRIBE	A default unsubscribe link included in the header of a message.
SHARE_MIRROR	A link that tracks the number of times a message shared on a social network is clicked.