TOtotalpass
Analytics

Retrieves monthly beneficiary rankings

This endpoint generates a ranking of beneficiaries based on their usage frequency within a specific month. It highlights the top users (both holders and dependents), showing their ranking position, total usage count, and the moment the goal was completed.

get/api/companies/v1/analytic/monthly_beneficiary_rankings

Request

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

Response

returns the monthly beneficiary rankings summary details

Example response

{
  "data": [
    {
      "key": "09234567810",
      "value": "30",
      "reference": "2025-09",
      "type": "holder",
      "ranking_position": "1",
      "completion_moment": "2025-09-30 08:00"
    }
  ]
}

Changes

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