ReportService
ReportService Description: ASMX, WSDL
ListBounceEvent:
ASMX,
XML
Description: List all Bounce Events within the given timeframe for this account.
Timespan between StartDate and EndDate must not exceed 48 hours.
Parameters: |
Name |
Type |
Description |
StartDate |
DateTime |
|
EndDate |
DateTime |
|
|
SoapHeader: |
Name |
Type |
Description |
Username |
String |
Your API access username. |
Password |
String |
Your API access password. |
List |
String |
The account you want to access. |
|
PagingHeader: |
Name |
Type |
Description |
PageSize |
Int32 |
(Optional) The requested page size. |
PageNumber |
Int32 |
(Optional) The page number to retrieve. |
|
Return Value: |
Type |
Description |
ReportEventDataset.ReportBounceEventDataTable |
XSD |
ListBounceEventByMailingID:
ASMX,
XML
Description: List all Bounce Events for a given MailingID.
Parameters: |
Name |
Type |
Description |
MailingID |
Int32 |
|
|
SoapHeader: |
Name |
Type |
Description |
Username |
String |
Your API access username. |
Password |
String |
Your API access password. |
List |
String |
The account you want to access. |
|
PagingHeader: |
Name |
Type |
Description |
PageSize |
Int32 |
(Optional) The requested page size. |
PageNumber |
Int32 |
(Optional) The page number to retrieve. |
|
Return Value: |
Type |
Description |
ReportEventDataset.ReportBounceEventDataTable |
XSD |
ListClickstreamEvent:
ASMX,
XML
Description: List all Clickstream Events within the given timeframe for this account.
Timespan between StartDate and EndDate must not exceed 48 hours.
Parameters: |
Name |
Type |
Description |
StartDate |
DateTime |
|
EndDate |
DateTime |
|
|
SoapHeader: |
Name |
Type |
Description |
Username |
String |
Your API access username. |
Password |
String |
Your API access password. |
List |
String |
The account you want to access. |
|
PagingHeader: |
Name |
Type |
Description |
PageSize |
Int32 |
(Optional) The requested page size. |
PageNumber |
Int32 |
(Optional) The page number to retrieve. |
|
Return Value: |
Type |
Description |
ReportEventDataset.ReportClickstreamEventDataTable |
XSD |
ListClickstreamEventByMailingID:
ASMX,
XML
Description: List all Clickstream Events for a given MailingID.
Parameters: |
Name |
Type |
Description |
MailingID |
Int32 |
|
|
SoapHeader: |
Name |
Type |
Description |
Username |
String |
Your API access username. |
Password |
String |
Your API access password. |
List |
String |
The account you want to access. |
|
PagingHeader: |
Name |
Type |
Description |
PageSize |
Int32 |
(Optional) The requested page size. |
PageNumber |
Int32 |
(Optional) The page number to retrieve. |
|
Return Value: |
Type |
Description |
ReportEventDataset.ReportClickstreamEventDataTable |
XSD |
ListClickthroughEvent:
ASMX,
XML
Description: List all Clickthrough Events within the given timeframe for this account.
Timespan between StartDate and EndDate must not exceed 48 hours.
Parameters: |
Name |
Type |
Description |
StartDate |
DateTime |
|
EndDate |
DateTime |
|
|
SoapHeader: |
Name |
Type |
Description |
Username |
String |
Your API access username. |
Password |
String |
Your API access password. |
List |
String |
The account you want to access. |
|
PagingHeader: |
Name |
Type |
Description |
PageSize |
Int32 |
(Optional) The requested page size. |
PageNumber |
Int32 |
(Optional) The page number to retrieve. |
|
Return Value: |
Type |
Description |
ReportEventDataset.ReportClickthroughEventDataTable |
XSD |
ListClickthroughEventByMailingID:
ASMX,
XML
Description: List all Clickthrough Events for a given MailingID.
Parameters: |
Name |
Type |
Description |
MailingID |
Int32 |
|
|
SoapHeader: |
Name |
Type |
Description |
Username |
String |
Your API access username. |
Password |
String |
Your API access password. |
List |
String |
The account you want to access. |
|
PagingHeader: |
Name |
Type |
Description |
PageSize |
Int32 |
(Optional) The requested page size. |
PageNumber |
Int32 |
(Optional) The page number to retrieve. |
|
Return Value: |
Type |
Description |
ReportEventDataset.ReportClickthroughEventDataTable |
XSD |
ListNamedClickthroughEvent:
ASMX,
XML
Description: List all Clickthrough Events within the given timeframe for this account. Includes the URI name.
Timespan between StartDate and EndDate must not exceed 48 hours.
Parameters: |
Name |
Type |
Description |
StartDate |
DateTime |
|
EndDate |
DateTime |
|
|
SoapHeader: |
Name |
Type |
Description |
Username |
String |
Your API access username. |
Password |
String |
Your API access password. |
List |
String |
The account you want to access. |
|
PagingHeader: |
Name |
Type |
Description |
PageSize |
Int32 |
(Optional) The requested page size. |
PageNumber |
Int32 |
(Optional) The page number to retrieve. |
|
Return Value: |
Type |
Description |
ReportEventDataset.ReportNamedClickthroughEventDataTable |
XSD |
ListNamedClickthroughEventByMailingID:
ASMX,
XML
Description: List all Clickthrough Events for a given MailingID. Includes the URI name.
Parameters: |
Name |
Type |
Description |
MailingID |
Int32 |
|
|
SoapHeader: |
Name |
Type |
Description |
Username |
String |
Your API access username. |
Password |
String |
Your API access password. |
List |
String |
The account you want to access. |
|
PagingHeader: |
Name |
Type |
Description |
PageSize |
Int32 |
(Optional) The requested page size. |
PageNumber |
Int32 |
(Optional) The page number to retrieve. |
|
Return Value: |
Type |
Description |
ReportEventDataset.ReportNamedClickthroughEventDataTable |
XSD |
ListOpenEvent:
ASMX,
XML
Description: List all Open Events with basic details within the given timeframe for this account.
Timespan between StartDate and EndDate must not exceed 48 hours.
Parameters: |
Name |
Type |
Description |
StartDate |
DateTime |
|
EndDate |
DateTime |
|
|
SoapHeader: |
Name |
Type |
Description |
Username |
String |
Your API access username. |
Password |
String |
Your API access password. |
List |
String |
The account you want to access. |
|
PagingHeader: |
Name |
Type |
Description |
PageSize |
Int32 |
(Optional) The requested page size. |
PageNumber |
Int32 |
(Optional) The page number to retrieve. |
|
Return Value: |
Type |
Description |
ReportEventDataset.ReportEventDataTable |
XSD |
ListOpenEventByMailingID:
ASMX,
XML
Description: List all Open Events with basic details for a given MailingID.
Parameters: |
Name |
Type |
Description |
MailingID |
Int32 |
|
|
SoapHeader: |
Name |
Type |
Description |
Username |
String |
Your API access username. |
Password |
String |
Your API access password. |
List |
String |
The account you want to access. |
|
PagingHeader: |
Name |
Type |
Description |
PageSize |
Int32 |
(Optional) The requested page size. |
PageNumber |
Int32 |
(Optional) The page number to retrieve. |
|
Return Value: |
Type |
Description |
ReportEventDataset.ReportEventDataTable |
XSD |
ListPurchaseEvent:
ASMX,
XML
Description: List all Purchase Events within the given timeframe for this account.
Timespan between StartDate and EndDate must not exceed 48 hours.
Parameters: |
Name |
Type |
Description |
StartDate |
DateTime |
|
EndDate |
DateTime |
|
|
SoapHeader: |
Name |
Type |
Description |
Username |
String |
Your API access username. |
Password |
String |
Your API access password. |
List |
String |
The account you want to access. |
|
PagingHeader: |
Name |
Type |
Description |
PageSize |
Int32 |
(Optional) The requested page size. |
PageNumber |
Int32 |
(Optional) The page number to retrieve. |
|
Return Value: |
Type |
Description |
ReportEventDataset.ReportPurchaseEventDataTable |
XSD |
ListPurchaseEventByMailingID:
ASMX,
XML
Description: List all Purchase Events for a given MailingID.
Parameters: |
Name |
Type |
Description |
MailingID |
Int32 |
|
|
SoapHeader: |
Name |
Type |
Description |
Username |
String |
Your API access username. |
Password |
String |
Your API access password. |
List |
String |
The account you want to access. |
|
PagingHeader: |
Name |
Type |
Description |
PageSize |
Int32 |
(Optional) The requested page size. |
PageNumber |
Int32 |
(Optional) The page number to retrieve. |
|
Return Value: |
Type |
Description |
ReportEventDataset.ReportPurchaseEventDataTable |
XSD |
ListReportSummaryData:
ASMX,
XML
Description: List all reporting statistics for the current account.
Parameters: |
none |
|
SoapHeader: |
Name |
Type |
Description |
Username |
String |
Your API access username. |
Password |
String |
Your API access password. |
List |
String |
The account you want to access. |
|
PagingHeader: |
Name |
Type |
Description |
PageSize |
Int32 |
(Optional) The requested page size. |
PageNumber |
Int32 |
(Optional) The page number to retrieve. |
|
Return Value: |
Type |
Description |
ReportSummaryDataDataset.ReportSummaryDataDataTable |
XSD |
ListReportSummaryDataByDateRange:
ASMX,
XML
Description: List all reporting statistics for a given date range.
Parameters: |
Name |
Type |
Description |
StartDate |
DateTime |
|
EndDate |
DateTime |
|
|
SoapHeader: |
Name |
Type |
Description |
Username |
String |
Your API access username. |
Password |
String |
Your API access password. |
List |
String |
The account you want to access. |
|
PagingHeader: |
Name |
Type |
Description |
PageSize |
Int32 |
(Optional) The requested page size. |
PageNumber |
Int32 |
(Optional) The page number to retrieve. |
|
Return Value: |
Type |
Description |
ReportSummaryDataDataset.ReportSummaryDataDataTable |
XSD |
ListReportSummaryDataByMailingID:
ASMX,
XML
Description: List all reporting statistics for a given MailingID.
Parameters: |
Name |
Type |
Description |
MailingID |
Int32 |
|
|
SoapHeader: |
Name |
Type |
Description |
Username |
String |
Your API access username. |
Password |
String |
Your API access password. |
List |
String |
The account you want to access. |
|
PagingHeader: |
Name |
Type |
Description |
PageSize |
Int32 |
(Optional) The requested page size. |
PageNumber |
Int32 |
(Optional) The page number to retrieve. |
|
Return Value: |
Type |
Description |
ReportSummaryDataDataset.ReportSummaryDataDataTable |
XSD |
ListSentEvent:
ASMX,
XML
Description: List all Sent Events within the given timeframe for this account.
Timespan between StartDate and EndDate must not exceed 48 hours.
Parameters: |
Name |
Type |
Description |
StartDate |
DateTime |
|
EndDate |
DateTime |
|
|
SoapHeader: |
Name |
Type |
Description |
Username |
String |
Your API access username. |
Password |
String |
Your API access password. |
List |
String |
The account you want to access. |
|
PagingHeader: |
Name |
Type |
Description |
PageSize |
Int32 |
(Optional) The requested page size. |
PageNumber |
Int32 |
(Optional) The page number to retrieve. |
|
Return Value: |
Type |
Description |
ReportEventDataset.ReportEventDataTable |
XSD |
ListSentEventByMailingID:
ASMX,
XML
Description: List all Sent Events for a given MailingID.
Parameters: |
Name |
Type |
Description |
MailingID |
Int32 |
|
|
SoapHeader: |
Name |
Type |
Description |
Username |
String |
Your API access username. |
Password |
String |
Your API access password. |
List |
String |
The account you want to access. |
|
PagingHeader: |
Name |
Type |
Description |
PageSize |
Int32 |
(Optional) The requested page size. |
PageNumber |
Int32 |
(Optional) The page number to retrieve. |
|
Return Value: |
Type |
Description |
ReportEventDataset.ReportEventDataTable |
XSD |
ListSuccessEvent:
ASMX,
XML
Description: List all Success Events within the given timeframe for this account.
Timespan between StartDate and EndDate must not exceed 48 hours.
Parameters: |
Name |
Type |
Description |
StartDate |
DateTime |
|
EndDate |
DateTime |
|
|
SoapHeader: |
Name |
Type |
Description |
Username |
String |
Your API access username. |
Password |
String |
Your API access password. |
List |
String |
The account you want to access. |
|
PagingHeader: |
Name |
Type |
Description |
PageSize |
Int32 |
(Optional) The requested page size. |
PageNumber |
Int32 |
(Optional) The page number to retrieve. |
|
Return Value: |
Type |
Description |
ReportEventDataset.ReportEventDataTable |
XSD |
ListSuccessEventByMailingID:
ASMX,
XML
Description: List all Success Events for a given MailingID.
Parameters: |
Name |
Type |
Description |
MailingID |
Int32 |
|
|
SoapHeader: |
Name |
Type |
Description |
Username |
String |
Your API access username. |
Password |
String |
Your API access password. |
List |
String |
The account you want to access. |
|
PagingHeader: |
Name |
Type |
Description |
PageSize |
Int32 |
(Optional) The requested page size. |
PageNumber |
Int32 |
(Optional) The page number to retrieve. |
|
Return Value: |
Type |
Description |
ReportEventDataset.ReportEventDataTable |
XSD |
ListUnsubscribeEvent:
ASMX,
XML
Description: List all Unsubscribe Events within the given timeframe for this account.
Timespan between StartDate and EndDate must not exceed 48 hours.
Parameters: |
Name |
Type |
Description |
StartDate |
DateTime |
|
EndDate |
DateTime |
|
|
SoapHeader: |
Name |
Type |
Description |
Username |
String |
Your API access username. |
Password |
String |
Your API access password. |
List |
String |
The account you want to access. |
|
PagingHeader: |
Name |
Type |
Description |
PageSize |
Int32 |
(Optional) The requested page size. |
PageNumber |
Int32 |
(Optional) The page number to retrieve. |
|
Return Value: |
Type |
Description |
ReportEventDataset.ReportEventDataTable |
XSD |
ListUnsubscribeEventByMailingID:
ASMX,
XML
Description: List all Unsubscribe Events for a given MailingID.
Parameters: |
Name |
Type |
Description |
MailingID |
Int32 |
|
|
SoapHeader: |
Name |
Type |
Description |
Username |
String |
Your API access username. |
Password |
String |
Your API access password. |
List |
String |
The account you want to access. |
|
PagingHeader: |
Name |
Type |
Description |
PageSize |
Int32 |
(Optional) The requested page size. |
PageNumber |
Int32 |
(Optional) The page number to retrieve. |
|
Return Value: |
Type |
Description |
ReportEventDataset.ReportEventDataTable |
XSD |