GET api/reports/subscription/retentionData?startDate={startDate}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
startDate

date

None.

Body Parameters

None.

Response Information

Resource Description

Collection of SubscriptionRetentionData
NameDescriptionTypeAdditional information
FirstOrderMonth

date

None.

SizeID

integer

None.

FrequencyID

integer

None.

MonthIndex

integer

None.

MonthData

Collection of integer

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "FirstOrderMonth": "2025-05-11T13:34:12.3490944+00:00",
    "SizeID": 2,
    "FrequencyID": 3,
    "MonthIndex": 4,
    "MonthData": [
      1,
      2
    ]
  },
  {
    "FirstOrderMonth": "2025-05-11T13:34:12.3490944+00:00",
    "SizeID": 2,
    "FrequencyID": 3,
    "MonthIndex": 4,
    "MonthData": [
      1,
      2
    ]
  }
]

application/xml, text/xml

Sample:
<ArrayOfSubscriptionRetentionData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/cag.Data.Reports">
  <SubscriptionRetentionData>
    <FirstOrderMonth>2025-05-11T13:34:12.3490944+00:00</FirstOrderMonth>
    <FrequencyID>3</FrequencyID>
    <MonthData xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </MonthData>
    <MonthIndex>4</MonthIndex>
    <SizeID>2</SizeID>
  </SubscriptionRetentionData>
  <SubscriptionRetentionData>
    <FirstOrderMonth>2025-05-11T13:34:12.3490944+00:00</FirstOrderMonth>
    <FrequencyID>3</FrequencyID>
    <MonthData xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </MonthData>
    <MonthIndex>4</MonthIndex>
    <SizeID>2</SizeID>
  </SubscriptionRetentionData>
</ArrayOfSubscriptionRetentionData>