GET api/v1/widgets/purchasescommunicationwdgt?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

SingleResultResponseOfWidgetWithDataDtoOfPurchasesCommunicationData
NameDescriptionTypeAdditional information
Meta

MetaSingleResult

None.

Notifications

None.

Response Formats

application/json, text/json

Sample:
{
  "meta": {},
  "notifications": [
    {},
    {}
  ],
  "result": {
    "id": "74927e9f-aae4-4a6a-b8b9-e530ff498e45",
    "code": "sample string 2",
    "data": {
      "total": 1.0,
      "totalWithPromotions": 2.0,
      "totalWithoutPromotions": 3.0,
      "totalWithEmailPromotions": 4.0,
      "totalWithSmsPromotions": 5.0
    }
  }
}

application/xml, text/xml

Sample:
<SingleResultResponseOfWidgetWithDataDtoOfPurchasesCommunicationDatadOvjT49_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:Total>1</d2p1:Total>
      <d2p1:TotalWithEmailPromotions>4</d2p1:TotalWithEmailPromotions>
      <d2p1:TotalWithPromotions>2</d2p1:TotalWithPromotions>
      <d2p1:TotalWithSmsPromotions>5</d2p1:TotalWithSmsPromotions>
      <d2p1:TotalWithoutPromotions>3</d2p1:TotalWithoutPromotions>
    </d2p1:Data>
    <d2p1:Id>74927e9f-aae4-4a6a-b8b9-e530ff498e45</d2p1:Id>
  </Result>
</SingleResultResponseOfWidgetWithDataDtoOfPurchasesCommunicationDatadOvjT49_PdOvjT49_P>