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

# Get apiv2organizations leadsdashboard



## OpenAPI

````yaml https://api.osiro.com/doc get /api/v2/organizations/{orgId}/leads/dashboard
openapi: 3.0.0
info:
  title: osiro API
  version: 2.0.0
servers: []
security: []
tags:
  - name: Funnel
    description: Public funnel rendering, submission, MFA, and analytics.
  - name: Booking
    description: A lead's cancel and reschedule of their booking, via the manage link.
  - name: Training
    description: Org-scoped sales-training catalogs, sessions, and call records.
  - name: Attribution
    description: Cross-domain PostHog identity handoff for the marketing site.
  - name: Billing
    description: Org-scoped checkouts, plans, trials and the Stripe billing portal.
  - name: Leads
    description: Org-scoped lead reads and actions.
  - name: Ad copy
    description: Org-scoped ad guidelines and Meta ad copy generation.
paths:
  /api/v2/organizations/{orgId}/leads/dashboard:
    get:
      tags:
        - Leads
      parameters:
        - schema:
            type: string
            format: uuid
          required: true
          name: orgId
          in: path
        - schema:
            type: string
            pattern: ^\d{4}-(0[1-9]|1[0-2])$
            description: Defaults to the current month (UTC).
          required: false
          description: Defaults to the current month (UTC).
          name: month
          in: query
      responses:
        '200':
          description: >-
            The osiro.direct dashboard for one month: buyer fill, refund rate
            and lead runway, over every sale the organization made
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LeadDashboard'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '429':
          description: Rate limited
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '500':
          description: Internal error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
components:
  schemas:
    LeadDashboard:
      type: object
      properties:
        month:
          type: string
          pattern: ^\d{4}-(0[1-9]|1[0-2])$
        is_current_month:
          type: boolean
        buyers:
          type: array
          items:
            type: object
            properties:
              email:
                type: string
              sold:
                type: integer
                minimum: 0
              sold_today:
                type: integer
                minimum: 0
              monthly_cap:
                type: integer
                minimum: 0
              saturation:
                type: number
                minimum: 0
              daily_cap_reached:
                type: boolean
              monthly_cap_reached:
                type: boolean
            required:
              - email
              - sold
              - sold_today
              - monthly_cap
              - saturation
              - daily_cap_reached
              - monthly_cap_reached
        refunds:
          type: object
          properties:
            monthly_rate:
              type: number
              minimum: 0
            days:
              type: array
              items:
                type: object
                properties:
                  day:
                    type: string
                    format: date
                  sold:
                    type: integer
                    minimum: 0
                  refund_rate:
                    type: number
                    minimum: 0
                required:
                  - day
                  - sold
                  - refund_rate
          required:
            - monthly_rate
            - days
        runway:
          type: object
          properties:
            demand:
              type: integer
              minimum: 0
            sold:
              type: integer
              minimum: 0
            remaining:
              type: integer
              minimum: 0
            reachable:
              type: integer
              minimum: 0
            days_elapsed:
              type: number
              minimum: 0
            days_left:
              type: number
              minimum: 0
            generated_per_day:
              type: number
              minimum: 0
            sell_through:
              type: number
              nullable: true
              minimum: 0
              maximum: 1
            refund_rate:
              type: number
              minimum: 0
              maximum: 1
            needed_generated:
              type: integer
              nullable: true
              minimum: 0
            needed_per_day:
              type: number
              nullable: true
              minimum: 0
            projected_generated:
              type: integer
              minimum: 0
            projected_fill:
              type: number
              minimum: 0
            gap:
              type: integer
              nullable: true
              minimum: 0
            series:
              type: array
              items:
                type: object
                properties:
                  day:
                    type: integer
                    minimum: 1
                    maximum: 31
                  generated:
                    type: number
                    nullable: true
                    minimum: 0
                  projected:
                    type: number
                    nullable: true
                    minimum: 0
                  needed:
                    type: number
                    nullable: true
                    minimum: 0
                required:
                  - day
                  - generated
                  - projected
                  - needed
          required:
            - demand
            - sold
            - remaining
            - reachable
            - days_elapsed
            - days_left
            - generated_per_day
            - sell_through
            - refund_rate
            - needed_generated
            - needed_per_day
            - projected_generated
            - projected_fill
            - gap
            - series
      required:
        - month
        - is_current_month
        - buyers
        - refunds
        - runway
    ApiError:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
          required:
            - code
            - message
      required:
        - error

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.