Reports – Help Center

Find herewith complete list of API functions regarding Reports.

getBasicNewsletterReport

Returns key statistical data related to a communication, included content summary report.

Parameter	Type
idNewsletter	String

Return values: MNNewsletterReport

Permissions: View journey statistics

queryDetailedNewsletterReport

Returns a data structure that combines contacts in a communication target.
If you want some RowSet's info, see Utility
Information for each contact:

Message has been sent
Message has been received
At least an opening has been done
At least one click has been done
Latest delivery date
Latest opening date
Latest click date
List of contents ids that have been clicked at least once
Detailed information about delivery problems (bounces)
Detailed information on email client and contact's operating system (used for interacting with a specific communication)

Parameter	Type	Description
idNewsletter	String
options	List of <Option>	Available options: Boolean bouncesdetails: reasons for "failed delivery" (bounce) Boolean clientinfo: contacts' email client, operating system and geolocation Boolean batchesdetail: very details info about each message (such as total messages sent, clicked, total clicks...) Boolean unsubscribeinfo: to get detailed information about the number of times a contact clicked on the unsubscription link in a specified communication and how many times the contact completed the unsubscription flow Boolean contentsdetails: contents that have been clicked String idGroup: retrieve records whose contacts belong to a specific audience. Available filter options: Boolean onlyBounces: retrieve records of bounced messages only (soft and hard bounces). Boolean onlyHardBounces: retrieve records of hard-bounced messages only. Boolean onlySoftBounces: retrieve records of soft-bounced messages only. Boolean onlyOpens: retrieve records whose contacts have opened the specified communication at least once. Boolean onlyClicks: retrieve records whose contacts have clicked a link in the specified communication at least once. Boolean onlyConversions: retrieve records whose contacts have converted a goal related to the specified communication. Boolean onlyComplaints: retrieve records whose contacts have complained the specified communication. Boolean onlyForwards: retrieve records whose contacts have forwarded the specified communication at least once. Boolean onlyUnsubscriptions: retrieve records whose contacts have completed the unsubscription process through the specified communication. Boolean onlyPlatformDesktop: retrieve records whose contacts have opened the specified communication in a desktop environment. Boolean onlyPlatformMobile: retrieve records whose contacts have opened the specified communication with their mobile phone. String channel: retrieve records only for specific channel. Values: "email","sms" (default "email"). Int iddelivery: retrieve records only for a specific Delivery. Boolean events: if true, retrieve a list of event done by the contact.

Return values: String

Permissions: View journey statistics

fetchDetailedNewsletterReport

Returns a page of results prepared with queryDetailedNewsletterReport

Parameter	Type
idRowSet	String
fromIndex	int
toIndex	int

Return values: List of MNContactNewsletterReport

Permissions: View journey statistics

queryDetailedContactReport

If you want some RowSet's info, see Utility
Returns a data structure that combines all communication' deliveries to a specific contact, for each communication you can get information about:

Message has been sent
Message has been received
At least an open has been recorded
At least a click has been recorded
Date of the latest delivery
Date of the latest opening
Date of the latest click
List of contents' id that have been clicked at least once
Delivery issues
Contact's email client and operating system (used for the activity on a specific communication)

Parameter	Type	Description
idContact	String
options	List of <Option>	Available options: Boolean bouncesdetails: reasons for "failed delivery" (bounce) Boolean clientinfo: contacts' email client, operating system and geolocation Boolean unsubscribeinfo: to get detailed information about the number of times a contact clicked on the unsubscription link in a specified communication and how many times the contact completed the unsubscription flow Boolean contentsdetails: contents that have been clicked Boolean channel: retrieve records only for specific channel. Values: "email","sms" (default "email"). Boolean events: if true, retrieve a list of event done by the contact.

Return values: String

Permissions: View database statistics for all databases

fetchDetailedContactReport

Returns a page of results prepared by queryDetailedContactReport.
For each MNContactNewsletterReport, with otherValues property you can view detailed information requested by Option defined with queryDetailedContactReport function

Parameter	Type
idRowSet	String
fromIndex	int
toIndex	int

Return values: List of MNContactNewsletterReport

Permissions: View database statistics for all databases

getBasicDatabaseReport

Returns an object with some basic information on the database.

Parameter	Type
idDatabase	String

Return values: MNDatabaseReport

Permissions: View database statistics

calculateContactReport

Returns a statistical summary report about a contact's activity on a communication.

Parameter	Type	Description
idContact	String
options	List of <Option>	Available options: Boolean bouncesdetails: reasons for "failed delivery" (bounce) Boolean clientinfo: contacts' email client, operating system and geolocation Boolean batchesdetail: returns additional information on total data (including the number of total clicks)

Return values: MNContactReport

Permissions: View database statistics for all databases

queryContactsReport

Calculates a statistical summary report for the input contacts and returns the id rowset that contains the report result. See fetchContactsReport to retrieve the reports.
If you want some RowSet's info, see Utility

Parameter	Type	Description
idContacts	List of String
options	List of <Option>	Available options: Boolean bouncesdetails: if true, in reports returned by fetchContactsReport, inside otherValues list you will also get: bouncedescription: latest bounce description for contact; lastbouncetype: latest bounce type (if the information is not available, "none" or "N/A"); lastbouncecategory: latest bounce category (if the information is not available, "none" or "N/A"). Boolean clientinfo: if true, in reports returned by fetchContactsReport, inside otherValues list you will also get: useragent; useragentdetail; useragenttype: webmail/software/privacy/not recognized; platform; platformdetail; platformtype: mobile/desktop/privacy/not recognized; geocity; geocode; geocountry; geoisp; georegion. Boolean batchesdetail: if true, in reports returned by fetchContactsReport, inside otherValues list you will also get: sentcount: number of messages sent to the contact; receivedcount: number of messages received from the contact; openedcount: number of messages opened by the contact; clickedcount: number of messages clicked by the contact; convertedcount: number of contact conversions; totalclicks: total clicks by contact; totalopens: total openings by contact; totalconvertions: total conversions by contact.

Return values: String

Permissions: View database statistics for all databases

fetchContactsReport

Returns a page of results prepared by queryContactsReport.
For each MNContactReport, with otherValues property you can view detailed information requested by Option defined with queryContactsReport function.

Parameter	Type
idRowSet	String
fromIndex	int
toIndex	int

Return values: List of MNContactReport

Permissions: View database statistics for all databases

getNewsletterReport

Returns key statistical data related to a communication.

Parameter	Type	Description
idNewsletter	String
options	List of <Option>	Available options: int iddelivery: if communication has been sent more than once, you can filter only one launch data by filling this option; int iddatabase: this option allow you to filter data of a specific database in communication target; int idgroup: this option allow you to filter data of a specific audience in communication target; String queryContacts: use this option to filter communication statistics by a contacts query, ie: SELECT * FROM CONTACTS WHERE email = 'name@domain.com'.

Return values: MNNewsletterReport

Permissions: View journey statistics

requestReport

Returns key statistical data related to a communication, this kind of reports may contain additional attachments, as PDF documents.

Beware of the report will not be available instantly, as the ReportStatus structure will contain a 'status' field which will contain the 'processing' value. You must poll the status of the Report, using the getReportStatus function.

Parameter	Type	Description
reportType	String	Type of report. Available values: 'newsletter_summary'
option	List of <Options>	Available options: int idNewsletter: id of the communication (only for reportType='newsletter_summary'); int idDelivery: if communication has been sent more than once, you can filter only one launch data by filling this option (only for reportType='newsletter_summary');

Return values: ReportStatus

Permissions: View journey statistics

getReportStatus

Returns the status of a Report, created using requestReport

Parameter	Type	Description
idReport	String	Id of the report, returned by requestReport

Return values: ReportStatus

Permissions: An user can access only reports requested by herself

downloadReportAttachment

Downloads a document attached to a report created using requestReport

Parameter	Type	Description
idReport	String	Id of the report, returned by requestReport
fileId	String	Id of the attachment, use the value of field id in structure ReportAttachment
options	List of <Option>	No options available

Return values: Binary content of the file

Permissions: An user can access only reports requested by herself