GET /experimental/reports/retention-value

Retrieves the total number of new customers for each aggregation period and the corresponding value for each customer over time.

Servers

https://api-sandbox.rebilly.com/organizations/{organizationId}
https://api.rebilly.com/organizations/{organizationId}

Query parameters

Name	Type	Required	Description
`limit`	Integer	No	Limits the number of collection items to be returned.
`aggregationPeriod`	String	No	Report aggregation period. Valid values: `"month"` `"day"` `"year"` `"quarter"` Default value: "month"
`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.
`includeDisputes`	String	No	Specifies whether to include disputes. Valid values: `"false"` `"true"` Default value: false
`sort[]`	Array	No	Sorts and orders the collection of items. To sort in descending order, prefix with `-`. Multiple fields can be sorted by separating each with `,`.
`includeRefunds`	String	No	Specifies whether to include refunds. Valid values: `"false"` `"true"` Default value: false
`periodStart`	String	No	Date and time when the report starts. If not provided, defaults to the start of the current month.
`periodEnd`	String	No	Date and time when the report ends. If not provided, defaults to the end of the current month.
`criteria`	String	No	Criteria parameter for requesting a collection.
`aggregationField`	String	No	Report aggregation field. Valid values: `"month"` `"leadsAffiliate"` `"leadsSalesAgent"` `"day"` `"leadsTerm"` `"leadsSource"` `"leadsMedium"` `"leadsCampaign"` `"quarter"` `"leadsContent"` `"bin"` `"leadsSubAffiliate"` `"year"` Default value: "month"
`offset`	Integer	No	Specifies the starting point within the collection of items to be returned.

How to start integrating

Add HTTP Task to your workflow definition.
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.
Click Test request to test run your request to the API and see the API's response.