YM REST Services

CampaignReports

**Requires Authentication**
Requires any of the roles:	admin, oauthadmin

The following routes are available for this service:
GET	/Ams/{ClientID}/CampaignReports/{CampaignId}/Messages	Return the Campaign Report details.
GET	/Ams/{ClientID}/CampaignReports/{CampaignId}	Return the Campaign Report details.
GET	/Ams/{ClientID}/CampaignReports/{CampaignId}/Messages/{MessageId}	Return a message's trace actions.

**CampaignReports** Parameters:
Name	Parameter	Data Type	Required
CampaignId	path	int	No
MessageId	path	string	No
ActivityFilter	query	int	No
RequestAction	query	RequestAction	No
FromDate	query	DateTime	No
ToDate	query	DateTime	No
TotalActivity	query	int	No
PageSize	query	int	No
PageNumber	query	int	No

**BaseDto** Parameters:
Name	Parameter	Data Type	Required
UsingRedis	form	bool	No
AppInitTime	form	DateTime	No
ServerID	form	string	No

**BaseSharedDto** Parameters:
Name	Parameter	Data Type	Required
ClientID	form	int	No
ResponseStatus	form	ResponseStatus	No
BypassCache	form	bool	No
DateCached	form	DateTime	No
Device	form	Device	No

**CampaignReportsResponse** Parameters:
Name	Parameter	Data Type	Required
Total	form	CampaignReportItem<int>	No
Rate	form	CampaignReportItem<float>	No
DailyTotal	form	List<CampaignReportItem<Int32>>	No
DailyRate	form	List<CampaignReportItem<Single>>	No
MessageActivity	form	List<CampaignReportMessageActivity>	No
Messages	form	List<CampaignReportMessage>	No

**CampaignReportItem<T>** Parameters:
Name	Parameter	Data Type	Required
Date	form	DateTime?	No
ListSize	form	T	No
Process	form	T	No
Send	form	T	No
Delivery	form	T	No
Open	form	T	No
OpenUnique	form	T	No
Click	form	T	No
ClickUnique	form	T	No
HardBounce	form	T	No
SoftBounce	form	T	No
Complaint	form	T	No
CategoryOptOut	form	T	No
EmailOptOut	form	T	No
SuppressHardBounce	form	T	No
SuppressCategoryOptOut	form	T	No
SuppressEmailOptOut	form	T	No
SuppressComplaint	form	T	No
Fail	form	T	No
Reject	form	T	No
NotOpen	form	T	No
NotSend	form	T	No
Accountability	form	T	No
EngagementScore	form	T	No
SuccessRate	form	T	No

**CampaignReportMessageActivity** Parameters:
Name	Parameter	Data Type	Required
TypeId	form	int	No
Name	form	string	No
Date	form	DateTime	No

**CampaignReportMessage** Parameters:
Name	Parameter	Data Type	Required
MemberId	form	int	No
FirstName	form	string	No
LastName	form	string	No
Email	form	string	No
MessageGuid	form	string	No
Activity	form	CampaignReportMessageActivity	No

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /Ams/{ClientID}/CampaignReports/{CampaignId}/Messages HTTP/1.1 
Host: ws.yourmembership.com 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CampaignReportsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/YM.Web.Services.Ams">
  <BypassCache xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">false</BypassCache>
  <ClientID xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">0</ClientID>
  <Device xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">Desktop</Device>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types" xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <ActivityFilter>0</ActivityFilter>
  <CampaignId>0</CampaignId>
  <FromDate>0001-01-01T00:00:00</FromDate>
  <MessageId>String</MessageId>
  <PageNumber>0</PageNumber>
  <PageSize>0</PageSize>
  <RequestAction>Details</RequestAction>
  <ToDate>0001-01-01T00:00:00</ToDate>
  <TotalActivity>0</TotalActivity>
  <DailyRate>
    <CampaignReportItemOffloat>
      <Accountability>0</Accountability>
      <CategoryOptOut>0</CategoryOptOut>
      <Click>0</Click>
      <ClickUnique>0</ClickUnique>
      <Complaint>0</Complaint>
      <Date>0001-01-01T00:00:00</Date>
      <Delivery>0</Delivery>
      <EmailOptOut>0</EmailOptOut>
      <EngagementScore>0</EngagementScore>
      <Fail>0</Fail>
      <HardBounce>0</HardBounce>
      <ListSize>0</ListSize>
      <NotOpen>0</NotOpen>
      <NotSend>0</NotSend>
      <Open>0</Open>
      <OpenUnique>0</OpenUnique>
      <Process>0</Process>
      <Reject>0</Reject>
      <Send>0</Send>
      <SoftBounce>0</SoftBounce>
      <SuccessRate>0</SuccessRate>
      <SuppressCategoryOptOut>0</SuppressCategoryOptOut>
      <SuppressComplaint>0</SuppressComplaint>
      <SuppressEmailOptOut>0</SuppressEmailOptOut>
      <SuppressHardBounce>0</SuppressHardBounce>
    </CampaignReportItemOffloat>
  </DailyRate>
  <DailyTotal>
    <CampaignReportItemOfint>
      <Accountability>0</Accountability>
      <CategoryOptOut>0</CategoryOptOut>
      <Click>0</Click>
      <ClickUnique>0</ClickUnique>
      <Complaint>0</Complaint>
      <Date>0001-01-01T00:00:00</Date>
      <Delivery>0</Delivery>
      <EmailOptOut>0</EmailOptOut>
      <EngagementScore>0</EngagementScore>
      <Fail>0</Fail>
      <HardBounce>0</HardBounce>
      <ListSize>0</ListSize>
      <NotOpen>0</NotOpen>
      <NotSend>0</NotSend>
      <Open>0</Open>
      <OpenUnique>0</OpenUnique>
      <Process>0</Process>
      <Reject>0</Reject>
      <Send>0</Send>
      <SoftBounce>0</SoftBounce>
      <SuccessRate>0</SuccessRate>
      <SuppressCategoryOptOut>0</SuppressCategoryOptOut>
      <SuppressComplaint>0</SuppressComplaint>
      <SuppressEmailOptOut>0</SuppressEmailOptOut>
      <SuppressHardBounce>0</SuppressHardBounce>
    </CampaignReportItemOfint>
  </DailyTotal>
  <MessageActivity>
    <CampaignReportMessageActivity>
      <Date>0001-01-01T00:00:00</Date>
      <Name>String</Name>
      <TypeId>0</TypeId>
    </CampaignReportMessageActivity>
  </MessageActivity>
  <Messages>
    <CampaignReportMessage>
      <Activity>
        <Date>0001-01-01T00:00:00</Date>
        <Name>String</Name>
        <TypeId>0</TypeId>
      </Activity>
      <Email>String</Email>
      <FirstName>String</FirstName>
      <LastName>String</LastName>
      <MemberId>0</MemberId>
      <MessageGuid>String</MessageGuid>
    </CampaignReportMessage>
  </Messages>
  <Rate>
    <Accountability>0</Accountability>
    <CategoryOptOut>0</CategoryOptOut>
    <Click>0</Click>
    <ClickUnique>0</ClickUnique>
    <Complaint>0</Complaint>
    <Date>0001-01-01T00:00:00</Date>
    <Delivery>0</Delivery>
    <EmailOptOut>0</EmailOptOut>
    <EngagementScore>0</EngagementScore>
    <Fail>0</Fail>
    <HardBounce>0</HardBounce>
    <ListSize>0</ListSize>
    <NotOpen>0</NotOpen>
    <NotSend>0</NotSend>
    <Open>0</Open>
    <OpenUnique>0</OpenUnique>
    <Process>0</Process>
    <Reject>0</Reject>
    <Send>0</Send>
    <SoftBounce>0</SoftBounce>
    <SuccessRate>0</SuccessRate>
    <SuppressCategoryOptOut>0</SuppressCategoryOptOut>
    <SuppressComplaint>0</SuppressComplaint>
    <SuppressEmailOptOut>0</SuppressEmailOptOut>
    <SuppressHardBounce>0</SuppressHardBounce>
  </Rate>
  <Total>
    <Accountability>0</Accountability>
    <CategoryOptOut>0</CategoryOptOut>
    <Click>0</Click>
    <ClickUnique>0</ClickUnique>
    <Complaint>0</Complaint>
    <Date>0001-01-01T00:00:00</Date>
    <Delivery>0</Delivery>
    <EmailOptOut>0</EmailOptOut>
    <EngagementScore>0</EngagementScore>
    <Fail>0</Fail>
    <HardBounce>0</HardBounce>
    <ListSize>0</ListSize>
    <NotOpen>0</NotOpen>
    <NotSend>0</NotSend>
    <Open>0</Open>
    <OpenUnique>0</OpenUnique>
    <Process>0</Process>
    <Reject>0</Reject>
    <Send>0</Send>
    <SoftBounce>0</SoftBounce>
    <SuccessRate>0</SuccessRate>
    <SuppressCategoryOptOut>0</SuppressCategoryOptOut>
    <SuppressComplaint>0</SuppressComplaint>
    <SuppressEmailOptOut>0</SuppressEmailOptOut>
    <SuppressHardBounce>0</SuppressHardBounce>
  </Total>
</CampaignReportsResponse>