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

# Real-time dashboard overview

> Returns live counts across printers, jobs, worklist tasks, hubs, and low-stock alerts. Internal cost / margin / profit fields are never exposed.



## OpenAPI

````yaml /api-reference/openapi.json get /analytics/overview
openapi: 3.1.0
info:
  title: AutoPrintFarm Public API
  version: 1.0.0
  description: >-
    Public API for AutoPrintFarm — read + write surface for printers, jobs,
    inventory, orders, SKUs, files, worklist, and assembly. Authorization uses
    three scopes: `read` (any list/get), `write` (data mutations — create,
    update, delete, uploads, fulfillment), and `control` (physical printer
    actions: start, pause, resume, stop, heaters, light, filament). Authenticate
    with an API key minted from Settings → API Keys in the AutoPrintFarm
    dashboard.
  contact:
    name: AutoPrintFarm
    url: https://autoprintfarm.com
servers:
  - url: https://api.autoprintfarm.com/public/v1
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Printers
    description: Printer fleet status
  - name: Jobs
    description: Print job queue and history
  - name: Inventory
    description: Finished-goods stock levels
  - name: Orders
    description: Customer orders and line items
  - name: Wiki
    description: Internal documentation articles
  - name: Worklist
    description: Operational task queue
  - name: Products
    description: Product catalog, SKUs, components, and color presets
  - name: Files
    description: Print file metadata and versions
  - name: Hubs
    description: Hub fleet and connection status
  - name: Assembly
    description: Post-print assembly tasks with bundled wiki
  - name: Materials
    description: Filament, components, packaging, and printer parts inventory
  - name: Analytics
    description: >-
      Dashboard rollups and reporting (overview, production, printers, failures,
      inventory, revenue)
paths:
  /analytics/overview:
    get:
      tags:
        - Analytics
      summary: Real-time dashboard overview
      description: >-
        Returns live counts across printers, jobs, worklist tasks, hubs, and
        low-stock alerts. Internal cost / margin / profit fields are never
        exposed.
      responses:
        '200':
          description: Overview snapshot
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - true
                  data:
                    $ref: '#/components/schemas/AnalyticsOverview'
                required:
                  - success
                  - data
        '401':
          description: Missing, invalid, revoked, or expired API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: API key lacks the required scope
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Rate limit exceeded (120 req/min/key)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - bearerAuth:
            - read
components:
  schemas:
    AnalyticsOverview:
      type: object
      properties:
        date:
          type: string
        printers:
          type: object
          properties:
            total:
              type: number
            idle:
              type: number
            printing:
              type: number
            paused:
              type: number
            maintenance:
              type: number
            offline:
              type: number
            error:
              type: number
          required:
            - total
            - idle
            - printing
            - paused
            - maintenance
            - offline
            - error
        jobs:
          type: object
          properties:
            pending:
              type: number
            queued:
              type: number
            printing:
              type: number
            processing:
              type: number
            today_completed:
              type: number
            today_failed:
              type: number
          required:
            - pending
            - queued
            - printing
            - processing
            - today_completed
            - today_failed
        tasks:
          type: object
          properties:
            pending:
              type: number
            collection:
              type: number
            assembly:
              type: number
            filament_change:
              type: number
          required:
            - pending
            - collection
            - assembly
            - filament_change
        hubs:
          type: object
          properties:
            total:
              type: number
            online:
              type: number
          required:
            - total
            - online
        alerts:
          type: object
          properties:
            low_stock:
              type: number
          required:
            - low_stock
      required:
        - date
        - printers
        - jobs
        - tasks
        - hubs
        - alerts
    Error:
      type: object
      properties:
        success:
          type: boolean
          enum:
            - false
        error:
          type: object
          properties:
            code:
              type: string
              description: >-
                Machine-readable error code (e.g. NOT_FOUND, VALIDATION_ERROR,
                FORBIDDEN, HUB_OFFLINE). Stable across releases — use this for
                branching.
              example: NOT_FOUND
            message:
              type: string
              description: >-
                Human-readable error message. May vary across releases — do not
                branch on this.
              example: Resource not found
            details:
              description: >-
                Optional structured detail. For VALIDATION_ERROR this is `{
                field: [messages] }`.
          required:
            - code
            - message
          description: Error detail object
      required:
        - success
        - error
      description: Standard error response envelope
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: apf_live_<64 hex>
      description: >-
        API keys are minted in the AutoPrintFarm web app under Settings → API
        Keys. Send as `Authorization: Bearer apf_live_...`. Keys are shown
        exactly once at creation and can be revoked at any time.

````