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

EmailAnalyticsResponseModel

Name	Description	Type	Additional information
CurrentMember	The current member	MobileMemberModel	None.
Members	The list of members	Collection of MobileMemberModel	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,
    "UserId": 2,
    "IsPrimary": true,
    "FirstName": "sample string 4",
    "LastName": "sample string 5",
    "FullName": "sample string 6",
    "UsherpaLOToken": "sample string 7",
    "MemberPhotoUrl": "sample string 8"
  },
  "Members": [
    {
      "MemberId": 1,
      "UserId": 2,
      "IsPrimary": true,
      "FirstName": "sample string 4",
      "LastName": "sample string 5",
      "FullName": "sample string 6",
      "UsherpaLOToken": "sample string 7",
      "MemberPhotoUrl": "sample string 8"
    },
    {
      "MemberId": 1,
      "UserId": 2,
      "IsPrimary": true,
      "FirstName": "sample string 4",
      "LastName": "sample string 5",
      "FullName": "sample string 6",
      "UsherpaLOToken": "sample string 7",
      "MemberPhotoUrl": "sample string 8"
    }
  ],
  "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 xmlns:d2p1="http://schemas.datacontract.org/2004/07/UsherpaLO.Domain.Models">
    <d2p1:FirstName>sample string 4</d2p1:FirstName>
    <d2p1:FullName>sample string 6</d2p1:FullName>
    <d2p1:IsPrimary>true</d2p1:IsPrimary>
    <d2p1:LastName>sample string 5</d2p1:LastName>
    <d2p1:MemberId>1</d2p1:MemberId>
    <d2p1:MemberPhotoUrl>sample string 8</d2p1:MemberPhotoUrl>
    <d2p1:UserId>2</d2p1:UserId>
    <d2p1:UsherpaLOToken>sample string 7</d2p1: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 xmlns:d2p1="http://schemas.datacontract.org/2004/07/UsherpaLO.Domain.Models">
    <d2p1:MobileMemberModel>
      <d2p1:FirstName>sample string 4</d2p1:FirstName>
      <d2p1:FullName>sample string 6</d2p1:FullName>
      <d2p1:IsPrimary>true</d2p1:IsPrimary>
      <d2p1:LastName>sample string 5</d2p1:LastName>
      <d2p1:MemberId>1</d2p1:MemberId>
      <d2p1:MemberPhotoUrl>sample string 8</d2p1:MemberPhotoUrl>
      <d2p1:UserId>2</d2p1:UserId>
      <d2p1:UsherpaLOToken>sample string 7</d2p1:UsherpaLOToken>
    </d2p1:MobileMemberModel>
    <d2p1:MobileMemberModel>
      <d2p1:FirstName>sample string 4</d2p1:FirstName>
      <d2p1:FullName>sample string 6</d2p1:FullName>
      <d2p1:IsPrimary>true</d2p1:IsPrimary>
      <d2p1:LastName>sample string 5</d2p1:LastName>
      <d2p1:MemberId>1</d2p1:MemberId>
      <d2p1:MemberPhotoUrl>sample string 8</d2p1:MemberPhotoUrl>
      <d2p1:UserId>2</d2p1:UserId>
      <d2p1:UsherpaLOToken>sample string 7</d2p1:UsherpaLOToken>
    </d2p1:MobileMemberModel>
  </Members>
</EmailAnalyticsResponseModel>