Get Renewals Stats

Get renewal statistics with period comparison.

GET /cabinet/admin/stats/sales/renewals

Get Renewals Stats

cURL

curl --request GET \
  --url https://api.example.com/cabinet/admin/stats/sales/renewals \
  --header 'Authorization: Bearer <token>'

200

{
  "total_renewals": 123,
  "total_revenue_kopeks": 123,
  "renewal_rate": 123,
  "current_period": {
    "count": 123,
    "revenue_kopeks": 123
  },
  "previous_period": {
    "count": 123,
    "revenue_kopeks": 123
  },
  "change": {
    "absolute": 123,
    "percent": 123,
    "trend": "<string>"
  },
  "daily": [
    {
      "date": "<string>",
      "count": 123
    }
  ]
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

days · integer | null · default: 30

start_date · string | null

end_date · string | null

Response

200

application/json

Successful Response

total_renewals · integer · required

total_revenue_kopeks · integer · required

renewal_rate · number · required

current_period · RenewalPeriodStats · object · required

Show child attributes

previous_period · RenewalPeriodStats · object · required

Show child attributes

change · RenewalChange · object · required

Show child attributes

daily · DailyRenewalItem · object[] · required

Show child attributes