Open Report

This method generates open 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/open?beginDate={beginDate}&endDate={endDate}

| Input parameters
Required parameters | Description | Output parameters | Description | | ----------------------------------------------------------------------------- | ----------- | ----------------- | ----------- | | token | The connection token | return | An open report is generated, otherwise an error code appears. | | beginDate | The start date of the date range.
The date format follows the ISO 8601 rules where date and time values are ordered from the most to the least significant.

Example:

• 2021-04-05
• 2021-04-05+02:00
• 2021-04-05T10:20:58
• 2021-04-05T10:20:58+02:00

*Note:*It is highly recommended to always include the time zone. If the time zone is omitted, the Actito server time zone will be used. | | | | endDate | The end date of the date range.
The date format follows the ISO 8601 rules where date and time values are ordered from the most to the least significant.

Example:

• 2021-04-05
• 2021-04-05+02:00
• 2021-04-05T10:20:58
• 2021-04-05T10:20:58+02:00

*Note:*It is highly recommended to always include the time zone. If the time zone is omitted, the Actito server time zone will be used. | | |

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/open?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/open?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>
    <open>
        <nmMessageId>45695</nmMessageId>
        <memberUID>CDC04000381EB79C</memberUID>
        <name>nmp_demo_rehar</name>
        <email>xxxx@xxx.com</email>
        <openDate>2018-08-13T12:58:33+01:00</openDate>
    </open>
    <open>
        <nmMessageId>45695</nmMessageId>
        <memberUID>CDC04000381EB79C</memberUID>
        <name>nmp_demo_rehar</name>
        <email>yyy@yyyy.com</email>
        <openDate>2018-08-13T10:15:47+01:00</openDate>
    </open>
</report>

JSON Output

{
       "open":
       [
           {
               "nmMessageId": 45695,
               "memberUID": "CDC04000381EB79C",
               "name": "nmp_demo_rehar",
               "email": "xxx@xxx.com",
               "openDate": "2018-08-13T12:58:33+01:00"
           },
           {
               "nmMessageId": 45695,
               "memberUID": "CDC04000381EB79C",
               "name": "nmp_demo_rehar",
               "email": "yyyy@yyyy.com",
               "openDate": "2018-08-13T10:15:47+01:00"
           }
       ]
    }