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

# Library Health



## OpenAPI

````yaml get /api/v2/insights/library-health
openapi: 3.0.0
info:
  version: 1.0.0
  title: Octave API
  description: API for Octave workspace management and AI-powered content generation
servers:
  - url: https://app.octavehq.com
security:
  - ApiKeyAuth: []
paths:
  /api/v2/insights/library-health:
    get:
      tags:
        - Insights
      summary: Library Health
      operationId: getLibraryHealth
      parameters:
        - schema:
            type: string
            enum:
              - week
              - month
              - quarter
            description: Period granularity
          required: true
          name: periodType
          in: query
        - schema:
            type: string
            format: date-time
            description: Start of the period window (ISO datetime)
          required: true
          name: periodStart
          in: query
      responses:
        '200':
          description: >-
            Per-entity-type health summary (findings, deal counts) for the
            heatmap
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/LibraryHealthRow'
                required:
                  - data
components:
  schemas:
    LibraryHealthRow:
      type: object
      properties:
        entityType:
          type: string
        entityCount:
          type: integer
        totalFindings:
          type: integer
        callFindings:
          type: integer
        emailFindings:
          type: integer
        wonDealCount:
          type: integer
        lostDealCount:
          type: integer
        totalDeals:
          type: integer
      required:
        - entityType
        - entityCount
        - totalFindings
        - callFindings
        - emailFindings
        - wonDealCount
        - lostDealCount
        - totalDeals
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: api_key

````