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

# Get dashboard stats

> Fetch EcoMail Hub dashboard summary cards for notice responses, delivery state, members, and prospects.



## OpenAPI

````yaml /api/ecomailhub.openapi.yaml get /dashboard/stats
openapi: 3.1.0
info:
  title: YouNegotiate EcoMail Hub API
  version: '2.0'
  description: Stateless API endpoints for EcoMail Hub / EcoPortal users.
servers:
  - url: https://api.ecomailhub.younegotiate.com
    description: Production
security: []
tags:
  - name: System
    description: Public EcoMail Hub domain system and health endpoints.
  - name: Authentication
    description: EcoMail Hub login, logout, password reset, and password change endpoints.
  - name: Profile
    description: Authenticated EcoMail Hub user profile endpoints.
  - name: Dashboard
    description: EcoMail Hub dashboard summary and notice-response bucket endpoints.
  - name: Manage Consumers
    description: >-
      EcoMail Hub consumer identity grouping and notice-response count
      endpoints.
  - name: Manage Creditors
    description: >-
      EcoMail Hub creditor profile and company-only member profile table
      endpoints.
  - name: Import Creditor Profiles
    description: EcoMail Hub creditor profile CSV import endpoints.
  - name: Manage Notice Response
    description: >-
      EcoMail Hub top-level notice-response review, reassignment, and close
      endpoints.
  - name: Manage Users
    description: EcoMail Hub user account management endpoints.
  - name: Reports
    description: EcoMail Hub one-time and scheduled CSV report endpoints.
  - name: Communications
    description: EcoMail Hub communication template editor endpoints.
paths:
  /dashboard/stats:
    get:
      tags:
        - Dashboard
      summary: Get dashboard stats
      description: >-
        Fetch EcoMail Hub dashboard summary cards for notice responses, delivery
        state, members, and prospects.
      operationId: ecomailhubDashboardStats
      responses:
        '200':
          description: Dashboard stats returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DashboardStatsResponse'
              example:
                data:
                  notice_responses:
                    total_count: 5
                    total_balance: 1500
                    total_balance_label: $1,500.00
                  delivered:
                    delivered_pending_count: 1
                    pending_delivery_count: 1
                  processed_offer:
                    added_count: 1
                    returned_count: 1
                  members:
                    active_count: 1
                    pending_count: 1
                  prospects:
                    yn_count: 1
                    consumer_count: 1
                    total_count: 2
        '401':
          $ref: '#/components/responses/Unauthenticated'
      security:
        - bearerAuth: []
components:
  schemas:
    DashboardStatsResponse:
      type: object
      required:
        - data
      properties:
        data:
          type: object
          required:
            - notice_responses
            - delivered
            - processed_offer
            - members
            - prospects
          properties:
            notice_responses:
              type: object
              required:
                - total_count
                - total_balance
                - total_balance_label
              properties:
                total_count:
                  type: integer
                  minimum: 0
                  example: 5
                total_balance:
                  type: number
                  format: float
                  minimum: 0
                  example: 1500
                total_balance_label:
                  type: string
                  example: $1,500.00
            delivered:
              type: object
              required:
                - delivered_pending_count
                - pending_delivery_count
              properties:
                delivered_pending_count:
                  type: integer
                  minimum: 0
                  example: 1
                pending_delivery_count:
                  type: integer
                  minimum: 0
                  example: 1
            processed_offer:
              type: object
              required:
                - added_count
                - returned_count
              properties:
                added_count:
                  type: integer
                  minimum: 0
                  example: 1
                returned_count:
                  type: integer
                  minimum: 0
                  example: 1
            members:
              type: object
              required:
                - active_count
                - pending_count
              properties:
                active_count:
                  type: integer
                  minimum: 0
                  example: 1
                pending_count:
                  type: integer
                  minimum: 0
                  example: 1
            prospects:
              type: object
              required:
                - yn_count
                - consumer_count
                - total_count
              properties:
                yn_count:
                  type: integer
                  minimum: 0
                  example: 1
                consumer_count:
                  type: integer
                  minimum: 0
                  example: 1
                total_count:
                  type: integer
                  minimum: 0
                  example: 2
    MessageResponse:
      type: object
      required:
        - message
      properties:
        message:
          type: string
  responses:
    Unauthenticated:
      description: Missing or invalid bearer token.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/MessageResponse'
          example:
            message: Unauthenticated.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Sanctum

````