> ## Documentation Index
> Fetch the complete documentation index at: https://docs.usecleff.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Beneficiary analytics

> The 'Beneficiaries' card payload: the distinct-beneficiary active count (+ % change vs the equal-length prior window) and a top-N-by-volume ranked list per currency. A pure read-model over Payout — nothing is stored. Results are scoped to the caller's Business and environment.



## OpenAPI

````yaml GET /v1/reporting/beneficiaries
openapi: 3.0.0
info:
  title: Cleff API
  description: >-
    Payout orchestration platform. All endpoints under /v1/ require an API key
    in the Authorization header (Bearer ck_<env>_<id>_<secret>).
  version: 0.0.1
  contact: {}
servers: []
security: []
tags: []
paths:
  /v1/reporting/beneficiaries:
    get:
      tags:
        - Reporting
      summary: >-
        Beneficiaries analytics over a window for the current Business and
        environment
      description: >-
        The 'Beneficiaries' card payload: the distinct-beneficiary active count
        (+ % change vs the equal-length prior window) and a top-N-by-volume
        ranked list per currency. A pure read-model over Payout — nothing is
        stored. Results are scoped to the caller's Business and environment.
      operationId: BeneficiariesController_get
      parameters:
        - name: from
          required: true
          in: query
          description: Inclusive lower bound of the window (ISO-8601 date or timestamp).
          schema:
            type: string
        - name: to
          required: true
          in: query
          description: >-
            Inclusive upper bound of the window (ISO-8601 date or timestamp). A
            date-only value covers the whole day.
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BeneficiariesResponseDto'
        '401':
          description: Missing or invalid credentials
      security:
        - api_key: []
components:
  schemas:
    BeneficiariesResponseDto:
      type: object
      properties:
        active_count:
          type: number
          description: >-
            Distinct beneficiaries with at least one Money-Out payout in the
            window.
        active_count_trend_pct:
          type: number
          nullable: true
          description: >-
            % change in the active-beneficiary count vs the equal-length prior
            window. Null when the prior window had none.
        rankings:
          description: One ranked list per currency present in the window — never blended.
          type: array
          items:
            $ref: '#/components/schemas/CurrencyRankingDto'
      required:
        - active_count
        - active_count_trend_pct
        - rankings
    CurrencyRankingDto:
      type: object
      properties:
        currency:
          type: string
          description: The currency this ranking is scoped to (never blended).
        top:
          description: Top beneficiaries by volume, desc.
          type: array
          items:
            $ref: '#/components/schemas/TopBeneficiaryDto'
      required:
        - currency
        - top
    TopBeneficiaryDto:
      type: object
      properties:
        beneficiary_id:
          type: string
          description: The paid Beneficiary's id.
        name:
          type: string
          nullable: true
          description: Resolved Beneficiary display name; null when unresolved.
        volume_minor:
          type: number
          description: >-
            Summed Money-Out volume in the window for this beneficiary +
            currency, minor units.
      required:
        - beneficiary_id
        - name
        - volume_minor
  securitySchemes:
    api_key:
      scheme: bearer
      bearerFormat: ck_<env>_<id>_<secret>
      type: http
      description: >-
        Cleff API key issued to a Business that self-registers via POST
        /v1/registration

````