TOtotalpass
Analytics

Retrieves monthly modalities rankings summary

This endpoint offers a ranking of the most utilized modalities (e.g., Gym, Swimming, Yoga) for the month based on usage count. It helps stakeholders understand which types of physical activities are most popular among the beneficiaries to tailor wellness programs.

get/api/companies/v1/analytic/monthly_modalities_rankings

Request

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

Response

returns the monthly modalities rankings by plans summary details

Example response

{
  "data": [
    {
      "key": "Gym",
      "reference": "2025-09",
      "value": 2,
      "type": "dependent"
    }
  ]
}

Changes

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