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

# List KPIs



## OpenAPI

````yaml api-reference/swagger.yaml get /api/v1/kpis
openapi: 3.0.3
info:
  title: FactoryPulse API
  version: 1.0.0
  description: API documentation for FactoryPulse application
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
servers:
  - url: '{protocol}://{host}'
    variables:
      protocol:
        enum:
          - http
          - https
        default: https
      host:
        default: lean.factorypulse.app
  - url: /api/v1
    description: API V1
security: []
paths:
  /api/v1/kpis:
    get:
      tags:
        - KPIs
      summary: List KPIs
      operationId: listKPIs
      responses:
        '200':
          description: KPIs found
          content:
            application/json:
              schema:
                type: object
                properties:
                  kpis:
                    type: array
                    items:
                      $ref: '#/components/schemas/KPI'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden - Invalid subscription
      security:
        - BearerAuth: []
components:
  schemas:
    KPI:
      type: object
      properties:
        id:
          type: integer
          example: 1
        name:
          type: string
          example: Production Rate
        description:
          type: string
          nullable: true
          example: Units produced per hour
        unit:
          type: string
          enum:
            - units
            - hours
            - percentage
            - count
            - kg
            - g
            - l
            - ml
            - pcs
            - doses
          example: units
        data_type:
          type: string
          enum:
            - number
            - currency
          example: number
        frequency:
          type: string
          enum:
            - shiftly
            - daily
            - weekly
            - monthly
          example: daily
        direction:
          type: string
          enum:
            - higher
            - lower
          example: higher
        aggregation:
          type: string
          enum:
            - sum
            - average
            - min
            - max
          example: sum
      required:
        - id
        - name
        - data_type
        - frequency
        - direction
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````