POST MarketingPerformanceReport/GetGraphData

Request Information

URI Parameters

None.

Body Parameters

IConnect.Domain.Reports.SalesReport.AutomatedMarketingReport.ReportViewModel
NameDescriptionTypeAdditional information
Criteria

integer

None.
ShowBy

IConnect.Domain.Reports.SalesReport.AutomatedMarketingReport.ShowBy

None.
SelectedCompanies

Collection of integer

None.
GroupByCampaing

boolean

None.
PageIndex

integer

None.
PageSize

integer

None.
ForPdf

boolean

None.
ReportFormat

IConnect.Domain.Reports.ExportFormat

None.
Start

date

None.
End

date

None.
StartDateObjectString

string

None.
EndDateObjectString

string

None.
SkipTimeZoneConvertion

boolean

None.
ForceImmediateExport

boolean

None.

Request Formats

application/json, text/json

Sample: 
{
  "Criteria": 1,
  "ShowBy": 0,
  "SelectedCompanies": [
    1,
    2
  ],
  "GroupByCampaing": true,
  "PageIndex": 1,
  "PageSize": 1,
  "ForPdf": true,
  "ReportFormat": 1,
  "Start": "2024-10-18T04:33:57.4699356-04:00",
  "End": "2024-10-18T04:33:57.4699356-04:00",
  "StartDateObjectString": "{\"year\":2024,\"month\":10,\"date\":18,\"hours\":4,\"minutes\":33,\"seconds\":57,\"miliseconds\":469}",
  "EndDateObjectString": "{\"year\":2024,\"month\":10,\"date\":18,\"hours\":4,\"minutes\":33,\"seconds\":57,\"miliseconds\":469}",
  "SkipTimeZoneConvertion": true,
  "ForceImmediateExport": true
}

application/xml, text/xml

Sample: 
<ReportViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IConnect.Domain.Reports.SalesReport.AutomatedMarketingReport">
  <_x003C_End_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/IConnect.Domain.Reports">2024-10-18T04:33:57.4699356-04:00</_x003C_End_x003E_k__BackingField>
  <_x003C_ForceImmediateExport_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/IConnect.Domain.Reports">true</_x003C_ForceImmediateExport_x003E_k__BackingField>
  <_x003C_SkipTimeZoneConvertion_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/IConnect.Domain.Reports">true</_x003C_SkipTimeZoneConvertion_x003E_k__BackingField>
  <_x003C_Start_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/IConnect.Domain.Reports">2024-10-18T04:33:57.4699356-04:00</_x003C_Start_x003E_k__BackingField>
  <_x003C_Criteria_x003E_k__BackingField>1</_x003C_Criteria_x003E_k__BackingField>
  <_x003C_ForPdf_x003E_k__BackingField>true</_x003C_ForPdf_x003E_k__BackingField>
  <_x003C_GroupByCampaing_x003E_k__BackingField>true</_x003C_GroupByCampaing_x003E_k__BackingField>
  <_x003C_PageIndex_x003E_k__BackingField>1</_x003C_PageIndex_x003E_k__BackingField>
  <_x003C_PageSize_x003E_k__BackingField>1</_x003C_PageSize_x003E_k__BackingField>
  <_x003C_ReportFormat_x003E_k__BackingField>ExcelXls</_x003C_ReportFormat_x003E_k__BackingField>
  <_x003C_SelectedCompanies_x003E_k__BackingField xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </_x003C_SelectedCompanies_x003E_k__BackingField>
  <_x003C_ShowBy_x003E_k__BackingField>ThisPeriod</_x003C_ShowBy_x003E_k__BackingField>
</ReportViewModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of IConnect.Domain.Reports.SalesReport.AutomatedMarketingReport.PerformanceReportItem
NameDescriptionTypeAdditional information
LocationId

integer

None.
SentDt

date

None.
FormattedDate

string

None.
Delivered

integer

None.
Opens

integer

None.
Visits

integer

None.
Redemptions

integer

None.
UnsubscribedQty

integer

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "LocationId": 1,
    "SentDt": "2024-10-18T04:33:57.4699356-04:00",
    "FormattedDate": "sample string 2",
    "Delivered": 3,
    "Opens": 4,
    "Visits": 5,
    "Redemptions": 6,
    "UnsubscribedQty": 7
  },
  {
    "LocationId": 1,
    "SentDt": "2024-10-18T04:33:57.4699356-04:00",
    "FormattedDate": "sample string 2",
    "Delivered": 3,
    "Opens": 4,
    "Visits": 5,
    "Redemptions": 6,
    "UnsubscribedQty": 7
  }
]

application/xml, text/xml

Sample: 
<ArrayOfPerformanceReportItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IConnect.Domain.Reports.SalesReport.AutomatedMarketingReport">
  <PerformanceReportItem>
    <Delivered>3</Delivered>
    <FormattedDate>sample string 2</FormattedDate>
    <LocationId>1</LocationId>
    <Opens>4</Opens>
    <Redemptions>6</Redemptions>
    <SentDt xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2024-10-18T08:33:57.4699356Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>-240</d3p1:OffsetMinutes>
    </SentDt>
    <UnsubscribedQty>7</UnsubscribedQty>
    <Visits>5</Visits>
  </PerformanceReportItem>
  <PerformanceReportItem>
    <Delivered>3</Delivered>
    <FormattedDate>sample string 2</FormattedDate>
    <LocationId>1</LocationId>
    <Opens>4</Opens>
    <Redemptions>6</Redemptions>
    <SentDt xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2024-10-18T08:33:57.4699356Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>-240</d3p1:OffsetMinutes>
    </SentDt>
    <UnsubscribedQty>7</UnsubscribedQty>
    <Visits>5</Visits>
  </PerformanceReportItem>
</ArrayOfPerformanceReportItem>