TOtotalpass
Analytics

Retrieves monthly cancellations summary

This endpoint retrieves a statistical summary of cancellations for a specified month, distinguishing between holders and dependents. It is essential for tracking churn rates and understanding retention trends within the company group over time.

get/api/companies/v1/analytic/monthly_cancellations

Request

  • Base URL
    https://hr.totalpass.com
  • URL
    https://hr.totalpass.com/api/companies/v1/analytic/monthly_cancellations
  • Auth
    API key in header x-api-key

Response

returns the monthly cancellation summary details

Example response

{
  "data": [
    {
      "key": "holders",
      "value": 25,
      "reference": "2025-09"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.