Name | Description |
---|---|
username | Your API access username. |
password | Your API access password. |
listname | The account you want to access. |
Parameters: | ||
---|---|---|
none | ||
Return Value: | ||
Type | Description | |
String |
Parameters: | ||
---|---|---|
none | ||
Return Value: | ||
Type | Description | |
CategoryDataset.CategoryDataTable |
Parameters: | ||
---|---|---|
Name | Type | Description |
behavior | String | Behavior to apply when modifying categories ADD -> add missing categories, error on existing categories; UPDATE -> ignore missing categories, update existing categories (default: ADD) |
categories | CategoryDataset.CategoryDataTable | The list of categories to add. NOTE: Adding a category with IsReadOnly set to 'True' will NOT allow deleting and only allow updates to Description and DirectoryID. |
Return Value: | ||
Type | Description | |
CategoryDataset.CategoryDataTable | See additional documentation. |
Parameters: | ||
---|---|---|
Name | Type | Description |
categoryNameOrId | String | The category name or category id. |
Return Value: | ||
Type | Description | |
CategoryDataset.CategoryDataTable |
Parameters: | ||
---|---|---|
Name | Type | Description |
categoryNameOrId | String | The category name or category id. |
Return Value: | ||
Type | Description | |
Boolean |
Parameters: | ||
---|---|---|
Name | Type | Description |
categoryNameOrId | String | The category name or category id. |
Paging Parameters: | ||
pageSize | Int32 | (Optional) The requested page size. Maximum of 10000. |
pageNumber | Int32 | (Optional) The page number to retrieve. |
Return Value: | ||
Type | Description | |
CategoryMemberDataset.CategoryMemberDataTable |
Parameters: | ||
---|---|---|
Name | Type | Description |
categoryNameOrId | String | The category name or category id. |
startDate | DateTime | Start of the reporting timeframe. |
endDate | DateTime | End of the reporting timeframe. |
Paging Parameters: | ||
pageSize | Int32 | (Optional) The requested page size. Maximum of 10000. |
pageNumber | Int32 | (Optional) The page number to retrieve. |
Return Value: | ||
Type | Description | |
CategoryMemberDataset.CategoryMemberDataTable |
Parameters: | ||
---|---|---|
Name | Type | Description |
categoryNameOrId | String | The category name or category id. |
startDate | DateTime | Start of the reporting timeframe. |
endDate | DateTime | End of the reporting timeframe. |
Paging Parameters: | ||
pageSize | Int32 | (Optional) The requested page size. Maximum of 10000. |
pageNumber | Int32 | (Optional) The page number to retrieve. |
Return Value: | ||
Type | Description | |
CategoryMemberDataset.CategoryMemberDataTable |
Parameters: | ||
---|---|---|
Name | Type | Description |
emailaddrs | Array of String | Array of Email addresses to search for. |
contactids | Array of Int32 | Array of ContactIDs to search for. |
Return Value: | ||
Type | Description | |
MemberDataset.MemberDataTable |
Parameters: | ||
---|---|---|
Name | Type | Description |
behavior | String | Behavior to apply when modifying contacts ADD -> Add missing contacts, error on existing contacts. UPDATE -> Ignore missing contacts, update existing contacts. UPSERT -> Add missing contacts, update existing contacts. UPSERTUSERID -> Perform an upsert operation, using the UserID as a key to allow email address changes. (UserID is required) UPDATECONTACTID -> Perform an update operation, using the ContactID as a key to allow email address changes. (ContactID is required) (default: UPSERT) |
contacts | MemberDataset.MemberDataTable | List of contacts and demographic information to add. |
categoryIDs | Array of Int32 | Array of CategoryIDs to add the affected contacts to. |
Return Value: | ||
Type | Description | |
MemberDataset.MemberDataTable | See additional documentation. |
Parameters: | ||
---|---|---|
Name | Type | Description |
emailOrId | String | The Email address or ContactID of an existing contact. |
Return Value: | ||
Type | Description | |
MemberDataset.MemberDataTable |
Parameters: | ||
---|---|---|
Name | Type | Description |
emailOrId | String | The Email address or ContactID of an existing contact. |
removePermanently | Boolean | Whether to remove the contact permanently (true), or to unsubscribe the contact (false). Contacts which are already unsubscribed may not be removed permanently. (default: false) |
Return Value: | ||
Type | Description | |
Boolean |
Parameters: | ||
---|---|---|
Name | Type | Description |
emailOrId | String | The Email address or ContactID of an existing contact. |
siteBan | Boolean | Whether to only ban in current account or entire site. (default false) |
Return Value: | ||
Type | Description | |
BannedMemberDataset.BannedMemberDataTable |
Parameters: | ||
---|---|---|
Name | Type | Description |
emailOrId | String | The Email address or ContactID of an existing contact. |
isSubscribed | Boolean | Whether to only return categories which the contact is currently subscribed to. (default true) |
Return Value: | ||
Type | Description | |
CategoryDataset.CategoryDataTable |
Parameters: | ||
---|---|---|
Name | Type | Description |
emailOrId | String | The Email address or ContactID of an existing contact. |
categoryIDs | Array of Int32 | Array of CategoryIDs to subscribe the contact to. |
Return Value: | ||
Type | Description | |
CategoryMemberDataset.CategoryMemberDataTable |
Parameters: | ||
---|---|---|
Name | Type | Description |
emailOrId | String | The Email address or ContactID of an existing contact. |
categoryNameOrId | String | The category name or category id. |
Return Value: | ||
Type | Description | |
CategoryMemberDataset.CategoryMemberDataTable |
Parameters: | ||
---|---|---|
Name | Type | Description |
emailOrId | String | The Email address or ContactID of an existing contact. |
categoryNameOrId | String | The category name or category id. |
Return Value: | ||
Type | Description | |
Boolean |
Parameters: | ||
---|---|---|
Name | Type | Description |
emailOrId | String | The Email address or ContactID of an existing contact. |
categoryNameOrId | String | The category name or category id. |
Return Value: | ||
Type | Description | |
Boolean |
Parameters: | ||
---|---|---|
Name | Type | Description |
emailOrId | String | The Email address or ContactID of an existing contact. |
Return Value: | ||
Type | Description | |
Boolean |
Parameters: | ||
---|---|---|
Name | Type | Description |
isSubscribed | Boolean | Whether to only return categories which the contacts are currently subscribed to. (default true) |
contactIDs | Array of Int32 | List of contacts to use to determine subscribed-to categories. |
Return Value: | ||
Type | Description | |
CategoryDataset.CategoryDataTable |
Parameters: | ||
---|---|---|
none | ||
Return Value: | ||
Type | Description | |
MemberTypeCountDataset.MemberTypeCountDataTable |
Parameters: | ||
---|---|---|
none | ||
Return Value: | ||
Type | Description | |
ExtendedDemographicsDataset.ExtendedDemographicTablesDataTable |
Parameters: | ||
---|---|---|
Name | Type | Description |
tableName | String | Custom Table name. |
rows | DataTable | Custom Table rows. See additional documentation. |
Return Value: | ||
Type | Description | |
DataTable | See additional documentation. |
Parameters: | ||
---|---|---|
Name | Type | Description |
tableName | String | Custom Table name. |
query | Query | (Optional) Query for records to return. See additional documentation. When specified, all primary key fields must be included. |
Paging Parameters: | ||
pageSize | Int32 | (Optional) The requested page size. Maximum of 10000. |
pageNumber | Int32 | (Optional) The page number to retrieve. |
Return Value: | ||
Type | Description | |
DataTable |
Parameters: | ||
---|---|---|
Name | Type | Description |
tableName | String | Custom Table name. |
query | Query | Query for record to delete. See additional documentation. All primary key fields must be specified. |
Return Value: | ||
Type | Description | |
DataTable | The record that was deleted. |
Parameters: | ||
---|---|---|
Name | Type | Description |
tableName | String | Custom Table name. |
emailOrId | String | The Email address or ContactID of an existing contact. |
query | Query | (Optional) Query for records to return. See additional documentation. |
Paging Parameters: | ||
pageSize | Int32 | (Optional) The requested page size. Maximum of 10000. |
pageNumber | Int32 | (Optional) The page number to retrieve. |
Return Value: | ||
Type | Description | |
DataTable |
Parameters: | ||
---|---|---|
Name | Type | Description |
tableName | String | Custom Table name. |
emailOrId | String | The Email address or ContactID of an existing contact. |
query | Query | Query for record to delete. See additional documentation. All primary key fields must be specified. |
Return Value: | ||
Type | Description | |
DataTable | The record that was deleted. |
Parameters: | ||
---|---|---|
Name | Type | Description |
tableName | String | Custom Table name. |
Return Value: | ||
Type | Description | |
SchemaTableDataset.SchemaTableDataTable |
Parameters: | ||
---|---|---|
none | ||
Expand Parameters: | ||
expand | String | (Optional) A comma-delimited list of associated tables. Specify any of the properties below to include them in the response. |
PickListValues | MemberDemographicInfoDataset.PickListValuesDataTable | |
Return Value: | ||
Type | Description | |
MemberDemographicInfoDataset.MemberDemographicInfoDataTable |
Parameters: | ||
---|---|---|
none | ||
Expand Parameters: | ||
expand | String | (Optional) A comma-delimited list of associated tables. Specify any of the properties below to include them in the response. |
PickListValues | MemberDemographicInfoDataset.PickListValuesDataTable | |
Return Value: | ||
Type | Description | |
MemberDemographicInfoDataset.MemberDemographicInfoDataTable |
Parameters: | ||
---|---|---|
Name | Type | Description |
demographic | String | Picklist Demographic. |
Return Value: | ||
Type | Description | |
MemberDemographicInfoDataset.MemberDemographicInfoPicklistValuesDataTable |
Parameters: | ||
---|---|---|
Name | Type | Description |
startDate | DateTime | Start of the reporting timeframe. |
endDate | DateTime | End of the reporting timeframe. |
Paging Parameters: | ||
pageSize | Int32 | (Optional) The requested page size. Maximum of 10000. |
pageNumber | Int32 | (Optional) The page number to retrieve. |
Return Value: | ||
Type | Description | |
MemberDataset.MemberDataTable |
Parameters: | ||
---|---|---|
Name | Type | Description |
startDate | DateTime | Start of the reporting timeframe. |
endDate | DateTime | End of the reporting timeframe. |
Paging Parameters: | ||
pageSize | Int32 | (Optional) The requested page size. Maximum of 10000. |
pageNumber | Int32 | (Optional) The page number to retrieve. |
Return Value: | ||
Type | Description | |
MemberDataset.MemberDataTable |
Parameters: | ||
---|---|---|
Name | Type | Description |
startDate | DateTime | Start of the reporting timeframe. |
Paging Parameters: | ||
pageSize | Int32 | (Optional) The requested page size. Maximum of 10000. |
pageNumber | Int32 | (Optional) The page number to retrieve. |
Return Value: | ||
Type | Description | |
MemberDataset.MemberDataTable |
Parameters: | ||
---|---|---|
none | ||
Return Value: | ||
Type | Description | |
MemberDataset.MemberDataTable |
Parameters: | ||
---|---|---|
none | ||
Return Value: | ||
Type | Description | |
MemberDataset.MemberDataTable |
Parameters: | ||
---|---|---|
Name | Type | Description |
behavior | String | Behavior to apply when modifying contacts UPSERT -> Add missing sms contacts, update existing sms contacts. UPDATE -> Ignore missing sms contacts, update existing sms contacts. (default: UPSERT) |
contacts | SMSMembersDataset.SMSMembersDataTable | List of sms contacts to add. |
Return Value: | ||
Type | Description | |
SMSMembersDataset.SMSMembersDataTable | See additional documentation. |
Parameters: | ||
---|---|---|
none | ||
Return Value: | ||
Type | Description | |
Int32 |
Parameters: | ||
---|---|---|
Name | Type | Description |
startDate | DateTime | Start of the reporting timeframe. |
endDate | DateTime | End of the reporting timeframe. |
Paging Parameters: | ||
pageSize | Int32 | (Optional) The requested page size. Maximum of 10000. |
pageNumber | Int32 | (Optional) The page number to retrieve. |
Return Value: | ||
Type | Description | |
MemberDataset.MemberDataTable |
Parameters: | ||
---|---|---|
none | ||
Return Value: | ||
Type | Description | |
ListDataset.ListDataTable |
Parameters: | ||
---|---|---|
none | ||
Paging Parameters: | ||
pageSize | Int32 | (Optional) The requested page size. |
pageNumber | Int32 | (Optional) The page number to retrieve. |
Expand Parameters: | ||
expand | String | (Optional) A comma-delimited list of associated tables. Specify any of the properties below to include them in the response. |
Segments | ApprovalMailDataset.ApprovalMailSegmentsDataTable | |
Return Value: | ||
Type | Description | |
ApprovalMailDataset.ApprovalMailDataTable |
Parameters: | ||
---|---|---|
Name | Type | Description |
newMail | MailDataset.MailDataTable | List of mailings to be created. |
Return Value: | ||
Type | Description | |
MailDataset.MailDataTable | See additional documentation. |
Parameters: | ||
---|---|---|
Name | Type | Description |
messageID | Int32 | The MessageID of an existing mailing in the approval queue. |
Expand Parameters: | ||
expand | String | (Optional) A comma-delimited list of associated tables. Specify any of the properties below to include them in the response. |
Segments | ApprovalMailDataset.ApprovalMailSegmentsDataTable | |
Return Value: | ||
Type | Description | |
ApprovalMailDataset.ApprovalMailDataTable |
Parameters: | ||
---|---|---|
Name | Type | Description |
messageID | Int32 | The MessageID of an existing mailing in the approval queue. |
Return Value: | ||
Type | Description | |
Boolean |
Parameters: | ||
---|---|---|
none | ||
Paging Parameters: | ||
pageSize | Int32 | (Optional) The requested page size. |
pageNumber | Int32 | (Optional) The page number to retrieve. |
Expand Parameters: | ||
expand | String | (Optional) A comma-delimited list of associated tables. Specify any of the properties below to include them in the response. |
Segments | ApprovalMailDataset.ApprovalMailSegmentsDataTable | |
Return Value: | ||
Type | Description | |
ApprovalMailDataset.ApprovalMailDataTable |
Parameters: | ||
---|---|---|
Name | Type | Description |
newMail | MailDataset.MailDataTable | List of mailings to be created. |
sendDateTime | DateTime | Schedule date/time for the mailings to be sent. |
Return Value: | ||
Type | Description | |
MailDataset.MailDataTable | See additional documentation. |
Parameters: | ||
---|---|---|
Name | Type | Description |
messageID | Int32 | The MessageID of an existing mailing in the approval or scheduled queue. |
sendDateTime | DateTime | Schedule date/time for the mailings to be sent. |
Return Value: | ||
Type | Description | |
Boolean |
Parameters: | ||
---|---|---|
Name | Type | Description |
messageID | Int32 | The MessageID of an existing mailing in the scheduled queue. |
Return Value: | ||
Type | Description | |
Boolean |
Parameters: | ||
---|---|---|
Name | Type | Description |
messageID | Int32 | The MessageID of an existing mailing in the approval or scheduled queue. |
sendDateTime | DateTime | Schedule date/time for the mailings to be sent. |
Return Value: | ||
Type | Description | |
Boolean |
Parameters: | ||
---|---|---|
Name | Type | Description |
messageID | Int32 | The MessageID of an existing mailing in the approval or scheduled queue. |
sendDateTime | DateTime | Schedule date/time for the mailings to be sent. |
Return Value: | ||
Type | Description | |
Boolean |
Parameters: | ||
---|---|---|
Name | Type | Description |
startDate | DateTime | |
endDate | DateTime | |
Paging Parameters: | ||
pageSize | Int32 | (Optional) The requested page size. Maximum of 10000. |
pageNumber | Int32 | (Optional) The page number to retrieve. |
Return Value: | ||
Type | Description | |
SentMailDataset.SentMailDataTable |
Parameters: | ||
---|---|---|
Name | Type | Description |
startDate | DateTime | |
endDate | DateTime | |
Paging Parameters: | ||
pageSize | Int32 | (Optional) The requested page size. Maximum of 10000. |
pageNumber | Int32 | (Optional) The page number to retrieve. |
Return Value: | ||
Type | Description | |
MailingStatisticsDataset.SentMailingSummaryDataTable |
Parameters: | ||
---|---|---|
Name | Type | Description |
messageID | Int32 | The MessageID of the mailing to be tested. May be a mailing in the approval or scheduled queues, or a transactional mailing. |
sendSpamTest | Boolean | Whether to generate a spam test report in addition to the test mailing. (default: false) |
toAddress | String | The address to send the test. |
Return Value: | ||
Type | Description | |
Int32 | The MessageID for the new test mailing. |
Parameters: | ||
---|---|---|
none | ||
Paging Parameters: | ||
pageSize | Int32 | (Optional) The requested page size. |
pageNumber | Int32 | (Optional) The page number to retrieve. |
Return Value: | ||
Type | Description | |
ApprovalMailDataset.ApprovalMailDataTable |
Parameters: | ||
---|---|---|
Name | Type | Description |
newMail | MailDataset.MailDataTable | List of mailings to be created. |
Return Value: | ||
Type | Description | |
MailDataset.MailDataTable | See additional documentation. |
Parameters: | ||
---|---|---|
Name | Type | Description |
messageID | Int32 | The MessageID of an existing transactional mailing. |
Return Value: | ||
Type | Description | |
ApprovalMailDataset.ApprovalMailDataTable |
Parameters: | ||
---|---|---|
Name | Type | Description |
messageID | Int32 | The MessageID of an existing mailing in the scheduled queue. |
Return Value: | ||
Type | Description | |
Boolean |
Parameters: | ||
---|---|---|
Name | Type | Description |
messageID | Int32 | The MessageID of an existing transactional mailing. |
contacts | MemberDataset.MemberDataTable | List of contacts and demographic information to add. |
Return Value: | ||
Type | Description | |
Int32 | The current outgoing MessageID for the specified transactional mailing. Useful for querying reports. |
Parameters: | ||
---|---|---|
Name | Type | Description |
messageID | Int32 | The MessageID of an existing transactional mailing. |
emailOrId | String | The Email address or ContactID of an existing contact. |
query | Query | (Optional) Query for records to mail merge. See additional documentation. Note: a query returning 0 records will result in the recipient being mailmerge aborted and not sent to. |
Return Value: | ||
Type | Description | |
Int32 | The current outgoing MessageID for the specified transactional mailing. Useful for querying reports. |
Parameters: | ||
---|---|---|
Name | Type | Description |
startDate | DateTime | Start of the reporting timeframe. |
endDate | DateTime | End of the reporting timeframe. |
Paging Parameters: | ||
pageSize | Int32 | (Optional) The requested page size. |
pageNumber | Int32 | (Optional) The page number to retrieve. |
Expand Parameters: | ||
expand | String | (Optional) A comma-delimited list of associated tables. Specify any of the properties below to include them in the response. |
Segment | SegmentDataset.SegmentDataTable | |
DripCampaign | DripCampaignsDataset.DripCampaignsDataTable | |
SplitTest | SplitTestDataset.SplitTestsDataTable | |
Return Value: | ||
Type | Description | |
ReportSummaryDataDataset.ReportSummaryDataDataTable |
Parameters: | ||
---|---|---|
Name | Type | Description |
mailingID | Int32 | The outgoing MessageID for a mailing that has already been sent. |
Paging Parameters: | ||
pageSize | Int32 | (Optional) The requested page size. |
pageNumber | Int32 | (Optional) The page number to retrieve. |
Expand Parameters: | ||
expand | String | (Optional) A comma-delimited list of associated tables. Specify any of the properties below to include them in the response. |
Segment | SegmentDataset.SegmentDataTable | |
DripCampaign | DripCampaignsDataset.DripCampaignsDataTable | |
SplitTest | SplitTestDataset.SplitTestsDataTable | |
Return Value: | ||
Type | Description | |
ReportSummaryDataDataset.ReportSummaryDataDataTable |
Parameters: | ||
---|---|---|
Name | Type | Description |
mailingID | Int32 | The outgoing MessageID for a mailing that has already been sent. |
Paging Parameters: | ||
pageSize | Int32 | (Optional) The requested page size. |
pageNumber | Int32 | (Optional) The page number to retrieve. |
Return Value: | ||
Type | Description | |
ReportEventDataset.ReportBounceEventDataTable |
Parameters: | ||
---|---|---|
Name | Type | Description |
mailingID | Int32 | The outgoing MessageID for a mailing that has already been sent. |
Paging Parameters: | ||
pageSize | Int32 | (Optional) The requested page size. |
pageNumber | Int32 | (Optional) The page number to retrieve. |
Return Value: | ||
Type | Description | |
ReportEventDataset.ReportClickstreamEventDataTable |
Parameters: | ||
---|---|---|
Name | Type | Description |
mailingID | Int32 | The outgoing MessageID for a mailing that has already been sent. |
Paging Parameters: | ||
pageSize | Int32 | (Optional) The requested page size. |
pageNumber | Int32 | (Optional) The page number to retrieve. |
Return Value: | ||
Type | Description | |
ReportEventDataset.ReportNamedClickthroughEventDataTable |
Parameters: | ||
---|---|---|
Name | Type | Description |
mailingID | Int32 | The outgoing MessageID for a mailing that has already been sent. |
Paging Parameters: | ||
pageSize | Int32 | (Optional) The requested page size. |
pageNumber | Int32 | (Optional) The page number to retrieve. |
Return Value: | ||
Type | Description | |
ReportEventDataset.ReportOpenEventDataTable |
Parameters: | ||
---|---|---|
Name | Type | Description |
mailingID | Int32 | The outgoing MessageID for a mailing that has already been sent. |
Paging Parameters: | ||
pageSize | Int32 | (Optional) The requested page size. |
pageNumber | Int32 | (Optional) The page number to retrieve. |
Return Value: | ||
Type | Description | |
ReportEventDataset.ReportEventDataTable |
Parameters: | ||
---|---|---|
Name | Type | Description |
mailingID | Int32 | The outgoing MessageID for a mailing that has already been sent. |
Paging Parameters: | ||
pageSize | Int32 | (Optional) The requested page size. |
pageNumber | Int32 | (Optional) The page number to retrieve. |
Return Value: | ||
Type | Description | |
ReportEventDataset.ReportPurchaseEventDataTable |
Parameters: | ||
---|---|---|
Name | Type | Description |
mailingID | Int32 | The outgoing MessageID for a mailing that has already been sent. |
Paging Parameters: | ||
pageSize | Int32 | (Optional) The requested page size. |
pageNumber | Int32 | (Optional) The page number to retrieve. |
Return Value: | ||
Type | Description | |
ReportEventDataset.ReportEventDataTable |
Parameters: | ||
---|---|---|
Name | Type | Description |
mailingID | Int32 | The outgoing MessageID for a mailing that has already been sent. |
Paging Parameters: | ||
pageSize | Int32 | (Optional) The requested page size. |
pageNumber | Int32 | (Optional) The page number to retrieve. |
Return Value: | ||
Type | Description | |
ReportEventDataset.ReportEventDataTable |
Parameters: | ||
---|---|---|
Name | Type | Description |
mailingID | Int32 | The outgoing MessageID for a mailing that has already been sent. |
Paging Parameters: | ||
pageSize | Int32 | (Optional) The requested page size. |
pageNumber | Int32 | (Optional) The page number to retrieve. |
Return Value: | ||
Type | Description | |
ReportEventDataset.ReportEventDataTable |
Parameters: | ||
---|---|---|
Name | Type | Description |
startDate | DateTime | Start of the reporting timeframe. |
endDate | DateTime | End of the reporting timeframe. |
Paging Parameters: | ||
pageSize | Int32 | (Optional) The requested page size. |
pageNumber | Int32 | (Optional) The page number to retrieve. |
Return Value: | ||
Type | Description | |
ReportEventDataset.ReportBounceEventDataTable |
Parameters: | ||
---|---|---|
Name | Type | Description |
startDate | DateTime | Start of the reporting timeframe. |
endDate | DateTime | End of the reporting timeframe. |
Paging Parameters: | ||
pageSize | Int32 | (Optional) The requested page size. |
pageNumber | Int32 | (Optional) The page number to retrieve. |
Return Value: | ||
Type | Description | |
ReportEventDataset.ReportClickstreamEventDataTable |
Parameters: | ||
---|---|---|
Name | Type | Description |
startDate | DateTime | Start of the reporting timeframe. |
endDate | DateTime | End of the reporting timeframe. |
Paging Parameters: | ||
pageSize | Int32 | (Optional) The requested page size. |
pageNumber | Int32 | (Optional) The page number to retrieve. |
Return Value: | ||
Type | Description | |
ReportEventDataset.ReportNamedClickthroughEventDataTable |
Parameters: | ||
---|---|---|
Name | Type | Description |
startDate | DateTime | Start of the reporting timeframe. |
endDate | DateTime | End of the reporting timeframe. |
Paging Parameters: | ||
pageSize | Int32 | (Optional) The requested page size. |
pageNumber | Int32 | (Optional) The page number to retrieve. |
Return Value: | ||
Type | Description | |
ReportEventDataset.ReportOpenEventDataTable |
Parameters: | ||
---|---|---|
Name | Type | Description |
startDate | DateTime | Start of the reporting timeframe. |
endDate | DateTime | End of the reporting timeframe. |
Paging Parameters: | ||
pageSize | Int32 | (Optional) The requested page size. |
pageNumber | Int32 | (Optional) The page number to retrieve. |
Return Value: | ||
Type | Description | |
ReportEventDataset.ReportEventDataTable |
Parameters: | ||
---|---|---|
Name | Type | Description |
startDate | DateTime | Start of the reporting timeframe. |
endDate | DateTime | End of the reporting timeframe. |
Paging Parameters: | ||
pageSize | Int32 | (Optional) The requested page size. |
pageNumber | Int32 | (Optional) The page number to retrieve. |
Return Value: | ||
Type | Description | |
ReportEventDataset.ReportPurchaseEventDataTable |
Parameters: | ||
---|---|---|
Name | Type | Description |
startDate | DateTime | Start of the reporting timeframe. |
endDate | DateTime | End of the reporting timeframe. |
Paging Parameters: | ||
pageSize | Int32 | (Optional) The requested page size. |
pageNumber | Int32 | (Optional) The page number to retrieve. |
Return Value: | ||
Type | Description | |
ReportEventDataset.ReportEventDataTable |
Parameters: | ||
---|---|---|
Name | Type | Description |
startDate | DateTime | Start of the reporting timeframe. |
endDate | DateTime | End of the reporting timeframe. |
Return Value: | ||
Type | Description | |
MemberStatisticsDataset.SubscriberActivityDataTable |
Parameters: | ||
---|---|---|
Name | Type | Description |
startDate | DateTime | Start of the reporting timeframe. |
endDate | DateTime | End of the reporting timeframe. |
Paging Parameters: | ||
pageSize | Int32 | (Optional) The requested page size. |
pageNumber | Int32 | (Optional) The page number to retrieve. |
Return Value: | ||
Type | Description | |
ReportEventDataset.ReportEventDataTable |
Parameters: | ||
---|---|---|
Name | Type | Description |
startDate | DateTime | Start of the reporting timeframe. |
endDate | DateTime | End of the reporting timeframe. |
Paging Parameters: | ||
pageSize | Int32 | (Optional) The requested page size. |
pageNumber | Int32 | (Optional) The page number to retrieve. |
Return Value: | ||
Type | Description | |
ReportEventDataset.ReportEventDataTable |
Parameters: | ||
---|---|---|
none | ||
Return Value: | ||
Type | Description | |
RoleDataset.RoleDataTable |
Parameters: | ||
---|---|---|
none | ||
Return Value: | ||
Type | Description | |
SegmentDataset.SegmentDataTable |
Parameters: | ||
---|---|---|
Name | Type | Description |
segmentNameOrId | String | The segment name or id. |
Return Value: | ||
Type | Description | |
SegmentDataset.SegmentDataTable |
Parameters: | ||
---|---|---|
Name | Type | Description |
siteName | String | The Site Name to add the Site Admin. |
newSiteAdminEmail | String | The Site Admin email address. |
newSiteAdminName | String | The Site Admin full name. |
Return Value: | ||
Type | Description | |
void |
Parameters: | ||
---|---|---|
none | ||
Return Value: | ||
Type | Description | |
WebhookDefinitionDataset.WebhookDefinitionDataTable |
Parameters: | ||
---|---|---|
Name | Type | Description |
webhooks | WebhookDefinitionDataset.WebhookDefinitionDataTable | |
Return Value: | ||
Type | Description | |
WebhookDefinitionDataset.WebhookDefinitionDataTable | See additional documentation. |
Parameters: | ||
---|---|---|
Name | Type | Description |
webhookNameOrId | String | |
Return Value: | ||
Type | Description | |
WebhookDefinitionDataset.WebhookDefinitionDataTable |
Parameters: | ||
---|---|---|
Name | Type | Description |
webhookNameOrId | String | |
Return Value: | ||
Type | Description | |
void |