POST api/Campaign/GetCampaignTimelineSummaryByFilters

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
AccountId	string	None.
UserId	string	None.
CampaignId	string	None.
CampaignSendSummaryId	string	None.
DaysFilterBy	TimelineDaysFilterBy	None.
ActivityFilters	Collection of CampaignTimelineActivityFilterViewModel	None.
CommunicationFilters	Collection of CampaignTimelineCommunicationFilterViewModel	None.
OfferFilters	Collection of CampaignTimelineOfferFilterViewModel	None.
CreatedDate	date	None.
PageSize	integer	None.
PageNumber	integer	None.
SearchValue	string	None.
TimeZoneId	string	None.
StartDate	date	None.
EndDate	date	None.

Request Formats

application/json, text/json

Sample:

{
  "AccountId": "sample string 1",
  "UserId": "sample string 2",
  "CampaignId": "sample string 3",
  "CampaignSendSummaryId": "sample string 4",
  "DaysFilterBy": "Last7Days",
  "ActivityFilters": [
    {
      "ActivityFilterBy": "OpensViews"
    },
    {
      "ActivityFilterBy": "OpensViews"
    }
  ],
  "CommunicationFilters": [
    {
      "CommunicationFilterBy": "Emails"
    },
    {
      "CommunicationFilterBy": "Emails"
    }
  ],
  "OfferFilters": [
    {
      "OfferFilterBy": "Awarded"
    },
    {
      "OfferFilterBy": "Awarded"
    }
  ],
  "CreatedDate": "2024-11-21T08:33:34.3636388+00:00",
  "PageSize": 6,
  "PageNumber": 7,
  "SearchValue": "sample string 8",
  "TimeZoneId": "sample string 9",
  "StartDate": "2024-11-21T08:33:34.3636388+00:00",
  "EndDate": "2024-11-21T08:33:34.3636388+00:00"
}

application/xml, text/xml

Sample:

<CampaignTimelineDetailFiltersViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models.ServiceModel">
  <AccountId>sample string 1</AccountId>
  <ActivityFilters>
    <CampaignTimelineActivityFilterViewModel>
      <ActivityFilterBy>OpensViews</ActivityFilterBy>
    </CampaignTimelineActivityFilterViewModel>
    <CampaignTimelineActivityFilterViewModel>
      <ActivityFilterBy>OpensViews</ActivityFilterBy>
    </CampaignTimelineActivityFilterViewModel>
  </ActivityFilters>
  <CampaignId>sample string 3</CampaignId>
  <CampaignSendSummaryId>sample string 4</CampaignSendSummaryId>
  <CommunicationFilters>
    <CampaignTimelineCommunicationFilterViewModel>
      <CommunicationFilterBy>Emails</CommunicationFilterBy>
    </CampaignTimelineCommunicationFilterViewModel>
    <CampaignTimelineCommunicationFilterViewModel>
      <CommunicationFilterBy>Emails</CommunicationFilterBy>
    </CampaignTimelineCommunicationFilterViewModel>
  </CommunicationFilters>
  <CreatedDate>2024-11-21T08:33:34.3636388+00:00</CreatedDate>
  <DaysFilterBy>Last7Days</DaysFilterBy>
  <EndDate>2024-11-21T08:33:34.3636388+00:00</EndDate>
  <OfferFilters>
    <CampaignTimelineOfferFilterViewModel>
      <OfferFilterBy>Awarded</OfferFilterBy>
    </CampaignTimelineOfferFilterViewModel>
    <CampaignTimelineOfferFilterViewModel>
      <OfferFilterBy>Awarded</OfferFilterBy>
    </CampaignTimelineOfferFilterViewModel>
  </OfferFilters>
  <PageNumber>7</PageNumber>
  <PageSize>6</PageSize>
  <SearchValue>sample string 8</SearchValue>
  <StartDate>2024-11-21T08:33:34.3636388+00:00</StartDate>
  <TimeZoneId>sample string 9</TimeZoneId>
  <UserId>sample string 2</UserId>
</CampaignTimelineDetailFiltersViewModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.