GET /experimental/reports/subscription-cancellation

Retrieves a subscription cancellation report.

Servers

Query parameters

Name Type Required Description
limit Integer No

Limits the number of collection items to be returned.

filter String No

Criteria for filtering collection items. This field requires a special format. Use , to specify multiple allowed values. Use ; to specify multiple fields.

For more information, see Search filters.

periodStart String No

Date and time when the report starts. If not specified, defaults to the first day of the current month.

periodEnd String No

Date and time when the report ends. If not specified, defaults to the last day of the current month.

aggregationField String No

Report aggregation field.

Valid values:

  • "leadSource.medium"
  • "leadSource.campaign"
  • "canceledBy"
  • "cancelCategory"
  • "leadSource.source"
  • "leadSource.subAffiliate"
  • "leadSource.term"
  • "leadSource.content"
  • "planId"
  • "leadSource.salesAgent"
  • "websiteId"
  • "leadSource.affiliate"

Default value: "planId"

offset Integer No

Specifies the starting point within the collection of items to be returned.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.