/
Retrieve a retention perc...

Retrieve a retention percentage report
Experimental

Request

Retrieves a retention percentage report.

Security
SecretApiKey or JWT
Query
aggregationFieldstring

Report aggregation field.

Default:"month"
Enum:"day""month""quarter""year"
aggregationPeriodstring

Report aggregation period.

Default:"month"
Enum:"day""month""quarter""year""cycle"
includeSwitchedSubscriptionsstring

Specifies whether to include switched subscriptions.

Enum:"true""false"
periodStartstring, (date-time)

Date and time when the report starts. If not provided, defaults to the start of the current month.

periodEndstring, (date-time)

Date and time when the report ends. If not provided, defaults to the end of the current month.

limitinteger, [ 0 .. 1000 ]

Limits the number of collection items to be returned.

offsetinteger, [ 0 .. 1000 ]

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

filterstring

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.

criteriastring

Criteria parameter for requesting a collection.

curl -i -X GET \
  'https://www.rebilly.com/_mock/catalog/all/experimental/reports/retention-percentage?aggregationField=day&aggregationPeriod=day&includeSwitchedSubscriptions=true&periodStart=2019-08-24T14%3A15%3A22Z&periodEnd=2019-08-24T14%3A15%3A22Z&limit=1000&offset=1000&filter=string&criteria=string' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'

Responses

Report retrieved.

Headers
Pagination-Totalinteger

Total number of items.

Example:332
Pagination-Limitinteger

Maximum number of items per page.

Example:100
Pagination-Offsetinteger

Specifies the starting point within the collection of resource results. For example, a request with limit=20 retrieves and displays the first 20 results on a page. A following request with limit=20 and offset=20, retrieves the next page of 20 results.

Example:2
Bodyapplication/json
dataArray of objects

Retention data.

Response
{
  "data": [
    { … }
  ]
}