Once returned with the data from /GetReportMetadata users can then execute the API call ExecuteReports. The parameters for this API call depend on the Parameters returned from: /GetReportMetadata
The example request below is what is submitted and returned for Report ID: 2.
Example
Collect recipient clicks:
EXAMPLE:
{
"SessionID":"00000000-00000-0000-0000000000000",
"UserID":"SAMPLE",
"Parameters":[{ "Parameters":[{
"Key":"@MessageId",
"Value":"12345678"
}],
"ReportId":2
}
HTTP POST
https://dna.magnetmail.net/ApiAdapter/Rest/ExecuteReport/
POST Parameters
NOTE: This call does not have conditional or optional parameters.
Required Parameters
| Parameter | Value | Description |
|---|---|---|
| SessionID | String | This is an authentication token which can be obtained by making the authenticate call. |
| UserID | String | The UserID returned in the authenticate call. |
| MessageID | Int | This is the ID of the message. Use the GetMessageList/ method to find the message by name and capture the message ID. Pass only a single value in this attribute. |
Response
[
{
"RecipientId": 123456789
"Email": "test@gmail.com",
"CustomId": "123456789",
"URL": "http://www.higherlogic.com",
"GrossClicks": 1,
"NetClicks": 1,
"Browser": "Chrome"
},
{
"RecipientId": 234567890,
"Email": "test1@gmail.com",
"CustomId": "123456789",
"URL": "https://www.higherlogic.com",
"GrossClicks": 1,
"NetClicks": 1,
"Browser": "Chrome"
},
]