GetDetailedTracking/ retrieves detailed tracking for a message sent from Higher Logic Thrive Marketing Enterprise (Thrive Marketing Enterprise).

NOTE: If there is a need for streamed tracking, contact support@higherlogic.com to inquire about API 105.

Example

Get detailed tracking:

EXAMPLE:
{
"SessionID":"00000000-00000-0000-0000000000000",
"UserID":"SAMPLE",
"MessageID":2147483647,
"NewGroups":[2147483647],
"Page":1,
"RecordsPerPage":50,
"ReportType":"email_sent",
"FromDate":"01/01/2016",
"ToDate":"06/09/2016"
}

HTTP POST

https://dna.magnetmail.net/ApiAdapter/Rest/GetDetailedTracking/

POST Parameters

Required Parameters

Parameter	Value	Description
SessionID	String	This is an authentication token that can be obtained by making the authenticate call.
UserID	String	The UserID returned in the authenticate call.
MessageID	Int	The Message ID.
FromDate	String	A date (MM/DD/YYYY) on which the search should begin.
ToDate	String	A date (MM/DD/YYYY) on which the search should end.
Page	Int	The page number for this call, the initial call to GetDetailedTracking will return the total number of records (TotalRecords) this based on your RecordsPerPage will supply the total number of pages to return.
RecordsPerPage	Int	The number of records to return, per page; the maximum is 2000.
ReportType	String	This is the report type to return valid variables: email_sent email_delivered email_bounced email_opened unsubscribe

Conditional Parameters

You may also include the following parameter. It may be required under some conditions.

Parameter

Value

Description

CustomParameters

String

This parameter is passed only when ReportType = email_bounced. Valid variables are the following bounce types:

SB - Generic Soft
HB - Generic Hard
MF - Mailbox Full
UNF - User Not Found
TU - Temporarily Unavailable
BD - Bad Domain
" " - Blank/Empty String

Optional Parameters

These parameters are not required under any condition.

Parameter	Value	Description
Email	String	Filter by email address of the recipient.
Fax	String	The fax number for the recipient record.
FirstName	String	The first name for the recipient record.
LastName	String	The last name for the recipient record.
GroupID	Int	Filter by Group ID.