logo

Retrieve a renewal sales report

Retrieves a renewal sales report.

SecuritySecretApiKey or JWT
Request
query Parameters
periodStart
required
string^\d{4}-\d{2}$

Date and time when the report starts.

Example: periodStart=2022-01
periodEnd
required
string^\d{4}-\d{2}$

Date and time when the report ends.

Example: periodEnd=2022-02
limit
integer [ 0 .. 1000 ]

Limits the number of collection items to be returned.

offset
integer >= 0

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

Responses
200

Report retrieved.

Response Headers
Pagination-Total
integer

Total number of items.

Example: 332
Pagination-Limit
integer

Maximum number of items per page.

Example: 100
Pagination-Offset
integer

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
Response Schema: application/json
Array of objects

Renewal sales data.

Array
aggregationValue
string

Date in YYYY-MM format.

newSales
number <double>

Total amount of new sales.

newRefunds
number <double>

Total amount of new refunds.

renewalSales
number <double>

Total amount of renewal sales.

renewalRefunds
number <double>

Total amount of renewal refunds.

401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

get/experimental/reports/renewal-sales
Request samples 
const params = {
    periodStart: '2017-09',
    periodEnd: '2017-09',
    limit: 20,
    offset: 0,
    tz: 0
};
const report = await api.reports.getRenewalSales(params);
Response samples
application/json
{
  • "data": [
    ]
}
➔ Next to Retrieve a retention percentage report