Error 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/error?beginDate={beginDate}&endDate={endDate}
| Input parameters
Required parameters | Description | Output parameters | Description |
| ----------------------------------------------------------------------------- | ----------- | ----------------- | ----------- |
| token | The connection token | return | An error 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/error?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/error?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>
<error>
<name>agu_local_NMP</name>
<nMmessageId>45534</nMmessageId>
<memberUid>xxx</memberUid>
<email>xxx@xxx.com</email>
<insertionDate>2018-08-13T12:58:33+01:00</insertionDate>
<sendDate>2018-08-13T12:58:33+01:00</sendDate>
<processDate>2018-08-13T12:58:33+01:00</processDate>
</error>
<error>
<name>nmp_content_pre_demo</name>
<nMmessageId>45696</nMmessageId>
<memberUid>FC54ACE86E02000F</memberUid>
<email>xxx@xxxx.com</email>
<insertionDate>2018-08-13T10:45:57+01:00</insertionDate>
<sendDate>2018-08-13T10:45:57+01:00</sendDate>
<processDate>2018-08-13T10:45:57+01:00</processDate>
</error>
</report>
JSON Output
{
"error":
[
{
"name": "agu_local_NMP",
"nMmessageId": 45534,
"memberUid": "xxx",
"email": "xxx@xx.com",
"insertionDate": "2018-08-13T12:58:33+01:00",
"sendDate": "2018-08-13T12:58:33+01:00",
"processDate": "2018-08-13T12:58:33+01:00"
},
{
"name": "nmp_content_pre_demo",
"nMmessageId": 45696,
"memberUid": "FC54ACE86E02000F",
"email": "xxx@xxxx.com",
"insertionDate": "2018-08-13T10:45:57+01:00",
"sendDate": "2018-08-13T10:45:57+01:00",
"processDate": "2018-08-13T10:45:57+01:00"
}
]
}
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. |