Prepare an Analysis Report
This method returns a campaign ID that can be used to generate an analysis report.
This is a POST method.
REST WADL
https://atmp-pub-api-www3.actito.com/apinmpreporting/application.wadl
REST URL
https://atmp-pub-api-www3.actito.com/apinmpreporting/analysis
| Input parameters
Required parameters | Description | Output parameters | Description |
| ----------------------------------------------------------------------------- | ----------- | ----------------- | ----------- |
| token | The connection token | return | A campaign id is returned. |
| url | The callback URL. | | |
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/analysis
Header
{token}
content-type application/xml
accept application/xml
Body
<url>
<callBackUrl>http://www.xxxxx.com/</callBackUrl>
</url>
JSON Input
URL
https://atmp-pub-api-www3.actito.com/apinmpreporting/analysis
Header
{token}
content-type application/json
accept application/json
Body
{
"callBackUrl": "http://www.xxxxx.com/"
}
Output
XML Output
<?xml version="1.0" encoding="UTF-8" ?>
<analysisId>
<id>{campaign id}</id>
</analysisId>
JSON Output
{ "id": "{campaign id}" }