GET /experimental/reports/retention-percentage
Retrieves a retention percentage report.
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:
Default value: "month" |
filter |
String | No |
Criteria for filtering collection items.
This field requires a special format.
Use For more information, see Search filters. |
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:
Default value: "month" |
includeSwitchedSubscriptions |
String | No |
Specifies whether to include switched subscriptions. Valid values:
|
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.