> ## 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.

# Hero KPIs

> The dashboard hero strip payload: beneficiary retention %, Money-Out payout count, and average payout size per currency across the requested window, each with the % change vs the equal-length prior window. A pure read-model over Payout — nothing is stored. Results are scoped to the caller's Business and environment.



## OpenAPI

````yaml GET /v1/reporting/hero-kpis
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/hero-kpis:
    get:
      tags:
        - Reporting
      summary: >-
        Hero KPI strip (retention %, payout count, avg payout size) for the
        current Business and environment
      description: >-
        The dashboard hero strip payload: beneficiary retention %, Money-Out
        payout count, and average payout size per currency across the requested
        window, each with the % change vs the equal-length prior window. A pure
        read-model over Payout — nothing is stored. Results are scoped to the
        caller's Business and environment.
      operationId: HeroKpisController_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/HeroKpisResponseDto'
        '401':
          description: Missing or invalid credentials
      security:
        - api_key: []
components:
  schemas:
    HeroKpisResponseDto:
      type: object
      properties:
        retention_pct:
          type: number
          nullable: true
          description: >-
            Repeat-payee rate: share of window beneficiaries also paid in the
            prior window. Null when the window paid no beneficiary.
        retention_trend_pct:
          type: number
          nullable: true
          description: >-
            % change in retention vs the prior window's retention; null with no
            baseline.
        payout_count:
          type: number
          description: Count of Money-Out payouts in the window.
        payout_count_trend_pct:
          type: number
          nullable: true
          description: '% change in payout count vs the prior window; null with no baseline.'
        avg_payout_size:
          description: >-
            Average payout size per currency present in the window, sorted by
            currency.
          type: array
          items:
            $ref: '#/components/schemas/AvgPayoutSizeDto'
      required:
        - retention_pct
        - retention_trend_pct
        - payout_count
        - payout_count_trend_pct
        - avg_payout_size
    AvgPayoutSizeDto:
      type: object
      properties:
        currency:
          type: string
          description: ISO currency code; never blended across currencies.
        avg_minor:
          type: number
          description: Mean Money-Out payout amount for the currency, minor units.
        trend_pct:
          type: number
          nullable: true
          description: >-
            % change vs the prior window's avg for this currency; null with no
            baseline.
      required:
        - currency
        - avg_minor
        - trend_pct
  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

````