---
title: "Retrieves monthly active beneficiaries summary by plans"
method: GET
path: "/api/companies/v1/analytic/monthly_active_beneficiary_by_plans"
tags: ["Analytics"]
---

# Retrieves monthly active beneficiaries summary by plans

`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`

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.

## Response `200`

returns the monthly active beneficiary by plans summary details

- object
  - `data` object[]
    - `key` string
    - `reference` string
    - `value` integer

## Other responses

- `401`: returns unauthorized when api key is invalid
- `404`: returns not found when there is no data
- `422`: returns unprocessable entity on unexpected errors

---

[API](https://skmtc.dev/totalpass/apis/api-companies.md) - [All operations](https://skmtc.dev/totalpass/apis/api-companies/llms.txt) - [OpenAPI document](https://skmtc.dev/totalpass/apis/api-companies/revisions/62259afde09a?raw)