POST AutomatedMarketingReport/GetMarketingLogs

Request Information

URI Parameters

None.

Body Parameters

IConnect.Domain.Reports.SalesReport.AutomatedMarketingReport.LogReportViewModel
NameDescriptionTypeAdditional information
IsGrouppedByCampaign

boolean

None.

Criteria

IConnect.Domain.Marketing.MarketingCriteria

None.

Status

IConnect.Domain.Marketing.MarketingSendingStatus

None.

SelectedCompanies

Collection of integer

None.

PageIndex

integer

None.

PageSize

integer

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:
{
  "IsGrouppedByCampaign": true,
  "Criteria": 1,
  "Status": 0,
  "SelectedCompanies": [
    1,
    2
  ],
  "PageIndex": 1,
  "PageSize": 1,
  "Start": "2024-10-18T04:39:33.2345517-04:00",
  "End": "2024-10-18T04:39:33.2345517-04:00",
  "StartDateObjectString": "{\"year\":2024,\"month\":10,\"date\":18,\"hours\":4,\"minutes\":39,\"seconds\":33,\"miliseconds\":234}",
  "EndDateObjectString": "{\"year\":2024,\"month\":10,\"date\":18,\"hours\":4,\"minutes\":39,\"seconds\":33,\"miliseconds\":234}",
  "SkipTimeZoneConvertion": true,
  "ForceImmediateExport": true
}

application/xml, text/xml

Sample:
<LogReportViewModel 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:39:33.2345517-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:39:33.2345517-04:00</_x003C_Start_x003E_k__BackingField>
  <Criteria>Birthday</Criteria>
  <IsGrouppedByCampaign>true</IsGrouppedByCampaign>
  <PageIndex>1</PageIndex>
  <PageSize>1</PageSize>
  <SelectedCompanies xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </SelectedCompanies>
  <Status>Pending</Status>
</LogReportViewModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IConnect.Core.PagedListOfIConnect.Domain.Reports.SalesReport.AutomatedMarketingReport.MarketingCycleLog
NameDescriptionTypeAdditional information
Data

Collection of IConnect.Domain.Reports.SalesReport.AutomatedMarketingReport.MarketingCycleLog

None.

Footer

IConnect.Domain.Reports.SalesReport.AutomatedMarketingReport.MarketingCycleLog

None.

PageFooter

IConnect.Domain.Reports.SalesReport.AutomatedMarketingReport.MarketingCycleLog

None.

PageNumber

integer

None.

PageSize

integer

None.

TotalRows

integer

None.

TotalPages

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "Data": [
    {
      "Id": 1,
      "CycleUid": "sample string 2",
      "OwnerCompanyId": 3,
      "CompanyId": 4,
      "Location": "sample string 5",
      "Locations": "sample string 6",
      "MarketingId": 7,
      "StartDt": "2024-10-18T04:39:33.2502125-04:00",
      "EndDt": "2024-10-18T04:39:33.2502125-04:00",
      "CampaignName": "sample string 9",
      "Criteria": 1,
      "Type": 1,
      "Status": 0,
      "SendingStatus": 0,
      "IsSendingCount": 10,
      "IsCompletedCount": 11,
      "LocationCount": 12,
      "SentSegments": 13,
      "SentDisclaimerSms": 14,
      "Target": 15,
      "Deliveries": 16,
      "Undelivered": 17,
      "SentWhileEnoughLimit": 18,
      "UnsentBecauseLimit": -3,
      "Cancelled": 19,
      "SkippedBecauseWrongPhone": 20,
      "NotYetSent": 21,
      "Unsent": 37,
      "StartDateString": "sample string 22",
      "EndDateString": "sample string 23",
      "CriteriaText": "Birthday, send X day(s) before",
      "TypeText": "Email",
      "StatusText": "sample string 24",
      "CanControl": false,
      "CanPause": false,
      "CanStop": false,
      "CanContinue": false,
      "CanRestart": false,
      "CanRetry": false
    },
    {
      "Id": 1,
      "CycleUid": "sample string 2",
      "OwnerCompanyId": 3,
      "CompanyId": 4,
      "Location": "sample string 5",
      "Locations": "sample string 6",
      "MarketingId": 7,
      "StartDt": "2024-10-18T04:39:33.2502125-04:00",
      "EndDt": "2024-10-18T04:39:33.2502125-04:00",
      "CampaignName": "sample string 9",
      "Criteria": 1,
      "Type": 1,
      "Status": 0,
      "SendingStatus": 0,
      "IsSendingCount": 10,
      "IsCompletedCount": 11,
      "LocationCount": 12,
      "SentSegments": 13,
      "SentDisclaimerSms": 14,
      "Target": 15,
      "Deliveries": 16,
      "Undelivered": 17,
      "SentWhileEnoughLimit": 18,
      "UnsentBecauseLimit": -3,
      "Cancelled": 19,
      "SkippedBecauseWrongPhone": 20,
      "NotYetSent": 21,
      "Unsent": 37,
      "StartDateString": "sample string 22",
      "EndDateString": "sample string 23",
      "CriteriaText": "Birthday, send X day(s) before",
      "TypeText": "Email",
      "StatusText": "sample string 24",
      "CanControl": false,
      "CanPause": false,
      "CanStop": false,
      "CanContinue": false,
      "CanRestart": false,
      "CanRetry": false
    }
  ],
  "Footer": {
    "Id": 1,
    "CycleUid": "sample string 2",
    "OwnerCompanyId": 3,
    "CompanyId": 4,
    "Location": "sample string 5",
    "Locations": "sample string 6",
    "MarketingId": 7,
    "StartDt": "2024-10-18T04:39:33.2502125-04:00",
    "EndDt": "2024-10-18T04:39:33.2502125-04:00",
    "CampaignName": "sample string 9",
    "Criteria": 1,
    "Type": 1,
    "Status": 0,
    "SendingStatus": 0,
    "IsSendingCount": 10,
    "IsCompletedCount": 11,
    "LocationCount": 12,
    "SentSegments": 13,
    "SentDisclaimerSms": 14,
    "Target": 15,
    "Deliveries": 16,
    "Undelivered": 17,
    "SentWhileEnoughLimit": 18,
    "UnsentBecauseLimit": -3,
    "Cancelled": 19,
    "SkippedBecauseWrongPhone": 20,
    "NotYetSent": 21,
    "Unsent": 37,
    "StartDateString": "sample string 22",
    "EndDateString": "sample string 23",
    "CriteriaText": "Birthday, send X day(s) before",
    "TypeText": "Email",
    "StatusText": "sample string 24",
    "CanControl": false,
    "CanPause": false,
    "CanStop": false,
    "CanContinue": false,
    "CanRestart": false,
    "CanRetry": false
  },
  "PageFooter": {
    "Id": 1,
    "CycleUid": "sample string 2",
    "OwnerCompanyId": 3,
    "CompanyId": 4,
    "Location": "sample string 5",
    "Locations": "sample string 6",
    "MarketingId": 7,
    "StartDt": "2024-10-18T04:39:33.2502125-04:00",
    "EndDt": "2024-10-18T04:39:33.2502125-04:00",
    "CampaignName": "sample string 9",
    "Criteria": 1,
    "Type": 1,
    "Status": 0,
    "SendingStatus": 0,
    "IsSendingCount": 10,
    "IsCompletedCount": 11,
    "LocationCount": 12,
    "SentSegments": 13,
    "SentDisclaimerSms": 14,
    "Target": 15,
    "Deliveries": 16,
    "Undelivered": 17,
    "SentWhileEnoughLimit": 18,
    "UnsentBecauseLimit": -3,
    "Cancelled": 19,
    "SkippedBecauseWrongPhone": 20,
    "NotYetSent": 21,
    "Unsent": 37,
    "StartDateString": "sample string 22",
    "EndDateString": "sample string 23",
    "CriteriaText": "Birthday, send X day(s) before",
    "TypeText": "Email",
    "StatusText": "sample string 24",
    "CanControl": false,
    "CanPause": false,
    "CanStop": false,
    "CanContinue": false,
    "CanRestart": false,
    "CanRetry": false
  },
  "PageNumber": 1,
  "PageSize": 2,
  "TotalRows": 3,
  "TotalPages": 4
}

application/xml, text/xml

Sample:
<PagedListOfMarketingCycleLog2YARzERM xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IConnect.Core">
  <PageNumber>1</PageNumber>
  <PageSize>2</PageSize>
  <TotalPages>4</TotalPages>
  <TotalRows>3</TotalRows>
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/IConnect.Domain.Reports.SalesReport.AutomatedMarketingReport">
    <d2p1:MarketingCycleLog>
      <d2p1:CampaignName>sample string 9</d2p1:CampaignName>
      <d2p1:Cancelled>19</d2p1:Cancelled>
      <d2p1:CompanyId>4</d2p1:CompanyId>
      <d2p1:Criteria>Birthday</d2p1:Criteria>
      <d2p1:CycleUid>sample string 2</d2p1:CycleUid>
      <d2p1:Deliveries>16</d2p1:Deliveries>
      <d2p1:EndDateString>sample string 23</d2p1:EndDateString>
      <d2p1:EndDt>2024-10-18T04:39:33.2502125-04:00</d2p1:EndDt>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:IsCompletedCount>11</d2p1:IsCompletedCount>
      <d2p1:IsSendingCount>10</d2p1:IsSendingCount>
      <d2p1:Location>sample string 5</d2p1:Location>
      <d2p1:LocationCount>12</d2p1:LocationCount>
      <d2p1:Locations>sample string 6</d2p1:Locations>
      <d2p1:MarketingId>7</d2p1:MarketingId>
      <d2p1:NotYetSent>21</d2p1:NotYetSent>
      <d2p1:OwnerCompanyId>3</d2p1:OwnerCompanyId>
      <d2p1:SendingStatus>Pending</d2p1:SendingStatus>
      <d2p1:SentDisclaimerSms>14</d2p1:SentDisclaimerSms>
      <d2p1:SentSegments>13</d2p1:SentSegments>
      <d2p1:SentWhileEnoughLimit>18</d2p1:SentWhileEnoughLimit>
      <d2p1:SkippedBecauseWrongPhone>20</d2p1:SkippedBecauseWrongPhone>
      <d2p1:StartDateString>sample string 22</d2p1:StartDateString>
      <d2p1:StartDt>2024-10-18T04:39:33.2502125-04:00</d2p1:StartDt>
      <d2p1:Status>Preparing</d2p1:Status>
      <d2p1:StatusText>sample string 24</d2p1:StatusText>
      <d2p1:Target>15</d2p1:Target>
      <d2p1:Type>Email</d2p1:Type>
      <d2p1:Undelivered>17</d2p1:Undelivered>
    </d2p1:MarketingCycleLog>
    <d2p1:MarketingCycleLog>
      <d2p1:CampaignName>sample string 9</d2p1:CampaignName>
      <d2p1:Cancelled>19</d2p1:Cancelled>
      <d2p1:CompanyId>4</d2p1:CompanyId>
      <d2p1:Criteria>Birthday</d2p1:Criteria>
      <d2p1:CycleUid>sample string 2</d2p1:CycleUid>
      <d2p1:Deliveries>16</d2p1:Deliveries>
      <d2p1:EndDateString>sample string 23</d2p1:EndDateString>
      <d2p1:EndDt>2024-10-18T04:39:33.2502125-04:00</d2p1:EndDt>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:IsCompletedCount>11</d2p1:IsCompletedCount>
      <d2p1:IsSendingCount>10</d2p1:IsSendingCount>
      <d2p1:Location>sample string 5</d2p1:Location>
      <d2p1:LocationCount>12</d2p1:LocationCount>
      <d2p1:Locations>sample string 6</d2p1:Locations>
      <d2p1:MarketingId>7</d2p1:MarketingId>
      <d2p1:NotYetSent>21</d2p1:NotYetSent>
      <d2p1:OwnerCompanyId>3</d2p1:OwnerCompanyId>
      <d2p1:SendingStatus>Pending</d2p1:SendingStatus>
      <d2p1:SentDisclaimerSms>14</d2p1:SentDisclaimerSms>
      <d2p1:SentSegments>13</d2p1:SentSegments>
      <d2p1:SentWhileEnoughLimit>18</d2p1:SentWhileEnoughLimit>
      <d2p1:SkippedBecauseWrongPhone>20</d2p1:SkippedBecauseWrongPhone>
      <d2p1:StartDateString>sample string 22</d2p1:StartDateString>
      <d2p1:StartDt>2024-10-18T04:39:33.2502125-04:00</d2p1:StartDt>
      <d2p1:Status>Preparing</d2p1:Status>
      <d2p1:StatusText>sample string 24</d2p1:StatusText>
      <d2p1:Target>15</d2p1:Target>
      <d2p1:Type>Email</d2p1:Type>
      <d2p1:Undelivered>17</d2p1:Undelivered>
    </d2p1:MarketingCycleLog>
  </Data>
  <Footer xmlns:d2p1="http://schemas.datacontract.org/2004/07/IConnect.Domain.Reports.SalesReport.AutomatedMarketingReport">
    <d2p1:CampaignName>sample string 9</d2p1:CampaignName>
    <d2p1:Cancelled>19</d2p1:Cancelled>
    <d2p1:CompanyId>4</d2p1:CompanyId>
    <d2p1:Criteria>Birthday</d2p1:Criteria>
    <d2p1:CycleUid>sample string 2</d2p1:CycleUid>
    <d2p1:Deliveries>16</d2p1:Deliveries>
    <d2p1:EndDateString>sample string 23</d2p1:EndDateString>
    <d2p1:EndDt>2024-10-18T04:39:33.2502125-04:00</d2p1:EndDt>
    <d2p1:Id>1</d2p1:Id>
    <d2p1:IsCompletedCount>11</d2p1:IsCompletedCount>
    <d2p1:IsSendingCount>10</d2p1:IsSendingCount>
    <d2p1:Location>sample string 5</d2p1:Location>
    <d2p1:LocationCount>12</d2p1:LocationCount>
    <d2p1:Locations>sample string 6</d2p1:Locations>
    <d2p1:MarketingId>7</d2p1:MarketingId>
    <d2p1:NotYetSent>21</d2p1:NotYetSent>
    <d2p1:OwnerCompanyId>3</d2p1:OwnerCompanyId>
    <d2p1:SendingStatus>Pending</d2p1:SendingStatus>
    <d2p1:SentDisclaimerSms>14</d2p1:SentDisclaimerSms>
    <d2p1:SentSegments>13</d2p1:SentSegments>
    <d2p1:SentWhileEnoughLimit>18</d2p1:SentWhileEnoughLimit>
    <d2p1:SkippedBecauseWrongPhone>20</d2p1:SkippedBecauseWrongPhone>
    <d2p1:StartDateString>sample string 22</d2p1:StartDateString>
    <d2p1:StartDt>2024-10-18T04:39:33.2502125-04:00</d2p1:StartDt>
    <d2p1:Status>Preparing</d2p1:Status>
    <d2p1:StatusText>sample string 24</d2p1:StatusText>
    <d2p1:Target>15</d2p1:Target>
    <d2p1:Type>Email</d2p1:Type>
    <d2p1:Undelivered>17</d2p1:Undelivered>
  </Footer>
  <PageFooter xmlns:d2p1="http://schemas.datacontract.org/2004/07/IConnect.Domain.Reports.SalesReport.AutomatedMarketingReport">
    <d2p1:CampaignName>sample string 9</d2p1:CampaignName>
    <d2p1:Cancelled>19</d2p1:Cancelled>
    <d2p1:CompanyId>4</d2p1:CompanyId>
    <d2p1:Criteria>Birthday</d2p1:Criteria>
    <d2p1:CycleUid>sample string 2</d2p1:CycleUid>
    <d2p1:Deliveries>16</d2p1:Deliveries>
    <d2p1:EndDateString>sample string 23</d2p1:EndDateString>
    <d2p1:EndDt>2024-10-18T04:39:33.2502125-04:00</d2p1:EndDt>
    <d2p1:Id>1</d2p1:Id>
    <d2p1:IsCompletedCount>11</d2p1:IsCompletedCount>
    <d2p1:IsSendingCount>10</d2p1:IsSendingCount>
    <d2p1:Location>sample string 5</d2p1:Location>
    <d2p1:LocationCount>12</d2p1:LocationCount>
    <d2p1:Locations>sample string 6</d2p1:Locations>
    <d2p1:MarketingId>7</d2p1:MarketingId>
    <d2p1:NotYetSent>21</d2p1:NotYetSent>
    <d2p1:OwnerCompanyId>3</d2p1:OwnerCompanyId>
    <d2p1:SendingStatus>Pending</d2p1:SendingStatus>
    <d2p1:SentDisclaimerSms>14</d2p1:SentDisclaimerSms>
    <d2p1:SentSegments>13</d2p1:SentSegments>
    <d2p1:SentWhileEnoughLimit>18</d2p1:SentWhileEnoughLimit>
    <d2p1:SkippedBecauseWrongPhone>20</d2p1:SkippedBecauseWrongPhone>
    <d2p1:StartDateString>sample string 22</d2p1:StartDateString>
    <d2p1:StartDt>2024-10-18T04:39:33.2502125-04:00</d2p1:StartDt>
    <d2p1:Status>Preparing</d2p1:Status>
    <d2p1:StatusText>sample string 24</d2p1:StatusText>
    <d2p1:Target>15</d2p1:Target>
    <d2p1:Type>Email</d2p1:Type>
    <d2p1:Undelivered>17</d2p1:Undelivered>
  </PageFooter>
</PagedListOfMarketingCycleLog2YARzERM>