/
Retrieve a renewal sales...

Retrieve a renewal sales report
Experimental

Request

Retrieves a renewal sales report.

Security
SecretApiKey or JWT
Query
periodStartstring^\d{4}-(0[1-9]|1[0-2])$

Date and time when the report starts. Defaults to the start of the current month.

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

Date and time when the report ends. Defaults to the end of the current month.

Example:periodEnd=2022-02
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.

curl -i -X GET \
  'https://www.rebilly.com/_mock/catalog/all/experimental/reports/renewal-sales?periodStart=2022-01&periodEnd=2022-02&limit=1000&offset=1000' \
  -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

Renewal sales data.

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