GET api/v1/widgets/mailcouponcommunicationswdgt?refresh={refresh}&monthsBack={monthsBack}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
refresh

boolean

Default value is False

monthsBack

integer

Default value is 12

Body Parameters

None.

Response Information

Resource Description

SingleResultResponseOfWidgetWithDataDtoOfMailCommunicationsData
NameDescriptionTypeAdditional information
Meta

MetaSingleResult

None.

Notifications

None.

Response Formats

application/json, text/json

Sample:
{
  "meta": {},
  "notifications": [
    {},
    {}
  ],
  "result": {
    "id": "0db1b836-f264-4d38-9f11-b66bec007a21",
    "code": "sample string 2",
    "data": {
      "recipients": 1,
      "opens": 2,
      "couponDownloads": 3,
      "couponUses": 4,
      "totalMoney": 5.0
    }
  }
}

application/xml, text/xml

Sample:
<SingleResultResponseOfWidgetWithDataDtoOfMailCommunicationsDatadOvjT49_PdOvjT49_P xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Presentation.WebApi.Dtos.Response">
  <Meta />
  <Notifications>
    <Notification />
    <Notification />
  </Notifications>
  <Result xmlns:d2p1="http://schemas.datacontract.org/2004/07/Application.Services.Dtos">
    <d2p1:Code>sample string 2</d2p1:Code>
    <d2p1:Data>
      <d2p1:CouponDownloads>3</d2p1:CouponDownloads>
      <d2p1:CouponUses>4</d2p1:CouponUses>
      <d2p1:Opens>2</d2p1:Opens>
      <d2p1:Recipients>1</d2p1:Recipients>
      <d2p1:TotalMoney>5</d2p1:TotalMoney>
    </d2p1:Data>
    <d2p1:Id>0db1b836-f264-4d38-9f11-b66bec007a21</d2p1:Id>
  </Result>
</SingleResultResponseOfWidgetWithDataDtoOfMailCommunicationsDatadOvjT49_PdOvjT49_P>