TOtotalpass
Analytics

Retrieves monthly gyms rankings summary

This endpoint lists the most popular gyms visited by the company's beneficiaries during the month, ranked by total check-ins. It helps to identify preferred fitness facilities among employees and aids in partnership or location strategy decisions.

get/api/companies/v1/analytic/monthly_gyms_rankings

Request

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

Response

returns the monthly gyms rankings summary details

Example response

{
  "data": [
    {
      "key": "Academia A",
      "reference": "2025-09",
      "ranking_position": "1",
      "value": "150",
      "type": "holder"
    }
  ]
}

Changes

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