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

# Get Automation Rate

> Returns the automation-rate metric (human vs AI-handled contact split) for a workspace over a date range, including a zero-filled per-day series matching the Insights dashboard chart.



## OpenAPI

````yaml GET /v1/insights/automation_rate
openapi: 3.0.0
info:
  title: Conduit API
  version: 1.0.0
  description: Public API for Conduit.
servers:
  - url: https://api.conduit.ai
    description: Production
security: []
tags:
  - name: meta
    description: Discovery and API metadata endpoints.
  - name: agents
    description: >-
      V2 chat agent configuration, including instructions, skills, triggers, and
      automation behavior.
  - name: contacts
    description: >-
      Contact profile and contact-scoped related resources such as tickets and
      calls.
  - name: workspaces
    description: Workspaces accessible to the current API token.
  - name: escalations
    description: >-
      Chat escalations that require operator review, including message, proposed
      response, and disposition context when available.
  - name: conversations
    description: >-
      Canonical message threads. Use these endpoints to list threads, inspect
      conversation state, read transcripts, and send replies.
  - name: conversation-tags
    description: >-
      Conversation labels, root topics, and subtopics used for classification
      and topic analytics.
  - name: tickets
    description: >-
      Operational queue items tied to conversations, including ticket-scoped
      transcripts and replies.
  - name: calls
    description: Phone call records, transcripts, summaries, and recordings when available.
  - name: reservations
    description: >-
      PMS reservations synced from the workspace's integrations (Hostaway,
      Guesty, Airbnb, etc.), including guest identity, payment status, and stay
      dates.
  - name: appointments
    description: >-
      Scheduled appointments (bookings) backed by the Conduit booking service.
      Exposes allocation context and the upstream booking-service `external_id`.
  - name: helpdesk_tickets
    description: >-
      Helpdesk tickets mirrored from external helpdesk integrations (Zendesk,
      Pylon, Plain), including requester identity and upstream metadata.
  - name: kb
    description: >-
      Knowledge base search and node management. Nodes represent knowledge base
      entries (files or directories), chunks are the indexed retrieval units
      used by search.
  - name: skills
    description: >-
      Workspace agent skills that can be attached to V2 chat agents.
      Sidebar/global-assistant skills are intentionally excluded.
  - name: custom_tools
    description: >-
      Custom code tools: user-authored Python/JavaScript functions executed in a
      sandbox when an agent calls them. Includes a runtimes endpoint describing
      the entrypoint signature, return shape, and available dependencies per
      language.
  - name: inbox_types
    description: >-
      Workspace inbox types. Each id is stable and usable as a message trigger's
      `inboxTypeId` and as the `inbox_type_id` filter on list conversations.
  - name: workflows
    description: >-
      Workspace automation workflows: definitions, executions, and per-execution
      event timelines.
  - name: insights
    description: Aggregated workspace analytics, such as conversation automation rate.
paths:
  /v1/insights/automation_rate:
    get:
      tags:
        - insights
      summary: Get automation rate
      description: >-
        Returns the automation-rate metric (human vs AI-handled contact split)
        for a workspace over a date range: numerator (AI-handled decisions),
        denominator (all decisions), rate, the echoed range, a formula_version
        to detect silent formula changes, and a per-day series (one zero-filled
        entry per calendar day in the range, ascending by date, each with its
        own numerator/denominator/rate) matching the Insights dashboard
        automation-rate chart. The top-level numerator/denominator equal the
        sums over the series. Hits BigQuery, so it carries a dedicated 10
        requests/minute per-workspace limit in addition to the general public
        API limit.
      operationId: getAutomationRate
      parameters:
        - schema:
            type: string
            description: Workspace to query.
            example: j57demo8f8x7c9v0n2q4r6t8y1u3i5o
          required: true
          name: workspace_id
          in: query
        - schema:
            type: string
            description: Inclusive range start (ISO 8601 date).
            example: '2026-06-01'
          required: true
          name: start_date
          in: query
        - schema:
            type: string
            description: Inclusive range end (ISO 8601 date). Max 90 days from start.
            example: '2026-06-30'
          required: true
          name: end_date
          in: query
        - schema:
            type: string
            description: >-
              Optional inbox type / contact category to segment by. Omit for the
              whole workspace.
            example: guest
          required: false
          name: category_name
          in: query
      responses:
        '200':
          description: Automation-rate metric for the workspace and date range
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      numerator:
                        type: number
                        description: >-
                          Count of AI-handled (send-like) agent-run decisions in
                          the range.
                      denominator:
                        type: number
                        description: >-
                          Count of all agent-run decisions in the range (the
                          human + AI split total).
                      rate:
                        type: number
                        description: >-
                          numerator / denominator, rounded to 4 decimals. 0 when
                          there are no decisions.
                      range:
                        type: object
                        properties:
                          start_date:
                            type: string
                          end_date:
                            type: string
                        required:
                          - start_date
                          - end_date
                        description: The inclusive date range the metric was computed over.
                      formula_version:
                        type: string
                        description: >-
                          Stable identifier for the numerator/denominator
                          formula. Diff it across responses to detect a silent
                          formula change.
                      series:
                        type: array
                        items:
                          type: object
                          properties:
                            date:
                              type: string
                              description: Bucket day, ISO 8601 date (YYYY-MM-DD).
                            numerator:
                              type: number
                              description: AI-handled decisions on this day.
                            denominator:
                              type: number
                              description: All decisions on this day.
                            rate:
                              type: number
                              description: >-
                                numerator / denominator for the day, rounded to
                                4 decimals. 0 when the day has no decisions.
                          required:
                            - date
                            - numerator
                            - denominator
                            - rate
                        description: >-
                          Per-day automation-rate buckets, one entry per
                          calendar day in the range (zero-filled, ascending by
                          date). This is the same series the Insights dashboard
                          automation-rate chart renders, bucketed in the
                          workspace timezone. The top-level
                          numerator/denominator equal the sums over this series.
                    required:
                      - numerator
                      - denominator
                      - rate
                      - range
                      - formula_version
                      - series
                required:
                  - data
                description: >-
                  Automation-rate metric (human vs AI-handled contact split) for
                  a workspace and date range.
                example:
                  data:
                    numerator: 40
                    denominator: 52
                    rate: 0.7692
                    range:
                      start_date: '2026-06-01'
                      end_date: '2026-06-30'
                    formula_version: '2026-07-10'
                    series:
                      - date: '2026-06-01'
                        numerator: 40
                        denominator: 52
                        rate: 0.7692
                      - date: '2026-06-02'
                        numerator: 0
                        denominator: 0
                        rate: 0
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                description: Standard error response.
                example:
                  error: Invalid workspace id
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                description: Standard error response.
                example:
                  error: Invalid workspace id
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                description: Standard error response.
                example:
                  error: Invalid workspace id
        '429':
          description: Rate limit exceeded
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                description: Standard error response.
                example:
                  error: Invalid workspace id
      security:
        - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Token
      description: >-
        Conduit API token. Use `Authorization: Bearer <token>`. Read/write
        endpoints require a token with write access.

````