GET api/emailanalytics/GetEmailCounts/{memberId}?startDate={startDate}&endDate={endDate}&showDismissed={showDismissed}
Get the email analytics for a member.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
memberId |
The member id. |
integer |
Required |
startDate |
The start date to search. |
date |
Required |
endDate |
The end date to search. |
date |
Required |
showDismissed |
The flag to show dismissed email analytics |
boolean |
Default value is False |
Body Parameters
None.
Response Information
Resource Description
.
EmailAnalyticsResponseModelName | Description | Type | Additional information |
---|---|---|---|
CurrentMember |
The current member |
MemberModel |
None. |
Members |
The list of members |
Collection of MemberModel |
None. |
EmailAnalytics |
The email analytics for a member |
Collection of EmailAnalyticsModel |
None. |
EmptyAlertDisplay |
The text displayed if no alerts are available |
string |
None. |
Response Formats
application/json, text/json
Sample:
{ "CurrentMember": { "memberId": 1, "isPrimary": true, "firstName": "sample string 3", "lastName": "sample string 4", "fullName": "sample string 5", "usherpaLOToken": "sample string 6", "memberPhotoUrl": "sample string 7" }, "Members": [ { "memberId": 1, "isPrimary": true, "firstName": "sample string 3", "lastName": "sample string 4", "fullName": "sample string 5", "usherpaLOToken": "sample string 6", "memberPhotoUrl": "sample string 7" }, { "memberId": 1, "isPrimary": true, "firstName": "sample string 3", "lastName": "sample string 4", "fullName": "sample string 5", "usherpaLOToken": "sample string 6", "memberPhotoUrl": "sample string 7" } ], "EmailAnalytics": [ { "processEmailId": 1, "campaignType": "sample string 2", "name": "sample string 3", "recipientCount": 4, "uniqueOpens": 5, "uniqueOpenPercentage": "125.00%", "uniqueClicks": 6, "uniqueClickPercentage": "120.00%", "hardBounces": 7, "dismissedDate": "sample string 8", "alertDisplay": "sample string 9", "viewEmailAnalyticsUrl": "sample string 10" }, { "processEmailId": 1, "campaignType": "sample string 2", "name": "sample string 3", "recipientCount": 4, "uniqueOpens": 5, "uniqueOpenPercentage": "125.00%", "uniqueClicks": 6, "uniqueClickPercentage": "120.00%", "hardBounces": 7, "dismissedDate": "sample string 8", "alertDisplay": "sample string 9", "viewEmailAnalyticsUrl": "sample string 10" } ], "EmptyAlertDisplay": "sample string 1" }
application/xml, text/xml
Sample:
<EmailAnalyticsResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/UsherpaLO.WebService.Mobile.Models"> <CurrentMember> <FirstName>sample string 3</FirstName> <FullName>sample string 5</FullName> <IsPrimary>true</IsPrimary> <LastName>sample string 4</LastName> <MemberId>1</MemberId> <MemberPhotoUrl>sample string 7</MemberPhotoUrl> <UsherpaLOToken>sample string 6</UsherpaLOToken> </CurrentMember> <EmailAnalytics> <EmailAnalyticsModel> <AlertDisplay>sample string 9</AlertDisplay> <CampaignType>sample string 2</CampaignType> <DismissedDate>sample string 8</DismissedDate> <HardBounces>7</HardBounces> <Name>sample string 3</Name> <ProcessEmailId>1</ProcessEmailId> <RecipientCount>4</RecipientCount> <UniqueClicks>6</UniqueClicks> <UniqueOpens>5</UniqueOpens> <ViewEmailAnalyticsUrl>sample string 10</ViewEmailAnalyticsUrl> </EmailAnalyticsModel> <EmailAnalyticsModel> <AlertDisplay>sample string 9</AlertDisplay> <CampaignType>sample string 2</CampaignType> <DismissedDate>sample string 8</DismissedDate> <HardBounces>7</HardBounces> <Name>sample string 3</Name> <ProcessEmailId>1</ProcessEmailId> <RecipientCount>4</RecipientCount> <UniqueClicks>6</UniqueClicks> <UniqueOpens>5</UniqueOpens> <ViewEmailAnalyticsUrl>sample string 10</ViewEmailAnalyticsUrl> </EmailAnalyticsModel> </EmailAnalytics> <EmptyAlertDisplay>sample string 1</EmptyAlertDisplay> <Members> <MemberModel> <FirstName>sample string 3</FirstName> <FullName>sample string 5</FullName> <IsPrimary>true</IsPrimary> <LastName>sample string 4</LastName> <MemberId>1</MemberId> <MemberPhotoUrl>sample string 7</MemberPhotoUrl> <UsherpaLOToken>sample string 6</UsherpaLOToken> </MemberModel> <MemberModel> <FirstName>sample string 3</FirstName> <FullName>sample string 5</FullName> <IsPrimary>true</IsPrimary> <LastName>sample string 4</LastName> <MemberId>1</MemberId> <MemberPhotoUrl>sample string 7</MemberPhotoUrl> <UsherpaLOToken>sample string 6</UsherpaLOToken> </MemberModel> </Members> </EmailAnalyticsResponseModel>