TOtotalpass
Analytics

Retrieves monthly active beneficiaries summary by plans

This endpoint provides a monthly summary of active beneficiaries categorized by their subscription plans (e.g., TP1, TP2). It allows partners to visualize the distribution of active users across different plan tiers for a specific reference period, aiding in financial and usage analysis.

get/api/companies/v1/analytic/monthly_active_beneficiary_by_plans

Request

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

Response

returns the monthly active beneficiary by plans summary details

Example response

{
  "data": [
    {
      "key": "TP 1",
      "reference": "2025-09",
      "value": 5
    }
  ]
}

Changes

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