Retrieve an ARR report
Experimental

Request

Retrieves an Annual Recurring Revenue (ARR) report.

Use ARR reports to view information on the predictable recurring revenue for your business over a period of months.

Security
SecretApiKey or JWT
Query
currencystring, = 3 characters(CurrencyCode)required
Revenue currency. If no value is provided, the organization reporting currency is used.
Example:currency=USD
periodStartstring^\d{4}-(0[1-9]|1[0-2])$required

Date and time when the report starts. If no value is provided or is null, the report starts at the beginning of the previous month.

Example:periodStart=2022-01
periodEndstring^\d{4}-(0[1-9]|1[0-2])$required

Date and time when the report ends. If no value is provided or is null, the report ends at the current month.

Example:periodEnd=2022-06
limitinteger, [ 0 .. 1000 ]

Limit the number of collection items to be returned. Use 0 to return an empty collection and still receive the count of matching items in Pagination-Total.

offsetinteger, [ 0 .. 1000 ]
Specifies the starting point within the collection of items to be returned.
curl -i -X GET \
  'https://www.rebilly.com/_mock/catalog/all/experimental/reports/annual-recurring-revenue?currency=USD&periodStart=2022-01&periodEnd=2022-06&limit=0&offset=0' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'

Responses

Report retrieved.
Headers
Pagination-Totalinteger

Total number of items that match the request. The value is independent of limit, including when limit is 0.

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

Annual Recurring Revenue (ARR) data.

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