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

# KPI Tiles

> Header KPI tiles, aggregated in the DB (deal_kpis view, or deal_kpis_search when
`q` is set), in display shape.

Aggregate KPI tiles (total, pipeline, avg close, at-risk), computed in the database (the `deal_kpis` view, or the `deal_kpis_search` RPC when `q` is set to a free-text search string).

### Auth

Requires a CRM read [scope](/authentication#scopes) and an active organization on the token. Any of `contacts:read`, `deals:read`, `companies:read`, or `activities:read` qualifies, as does any `*:manage` scope — manage implies read.

### Response

| Field      | Type              | Description                                         |
| ---------- | ----------------- | --------------------------------------------------- |
| `total`    | `integer`         | Total deal count.                                   |
| `pipeline` | `number`          | Sum of open deal value.                             |
| `avgClose` | `integer \| null` | Average days-to-close, or `null` if not computable. |
| `atRisk`   | `integer`         | Count of at-risk deals.                             |

Note the mixed casing — `total`/`pipeline` are lowercase, `avgClose`/`atRisk` are camelCase — this is the literal response shape, not a documentation typo.


## OpenAPI

````yaml GET /deals/kpis
openapi: 3.1.0
info:
  title: anycrm-api
  version: 0.0.1
servers: []
security: []
tags:
  - name: Customer Intelligence
    description: >-
      Company research and ICP-fit scoring — create a research run, track its
      progress, and read back scored companies as leads.
  - name: Outreach
    description: >-
      The cold-email management console — domains, mailboxes, and campaigns — as
      a thin control plane over the SalesForge stack.
  - name: AnyCard
    description: >-
      Authenticated CRUD for AnyCard, the org's digital business-card /
      lead-capture product.
  - name: AnyCard Events
    description: >-
      Event-attribution analytics for AnyCard — which captured leads converted,
      broken down by source, owner, and deal.
  - name: AnyCard Share Links
    description: >-
      Unauthenticated endpoints reached by anyone who scans a QR code or opens a
      shared AnyCard link.
  - name: AI
    description: >-
      A streaming (SSE) AI chat endpoint with account-commit actions it can take
      on the caller's behalf.
  - name: Analytics Assistant
    description: >-
      The natural-language analytics assistant — a guarded text-to-SQL loop
      (SSE) that answers ad-hoc questions over the org's CRM data as a
      least-privilege, read-only database role.
  - name: Account Readiness
    description: >-
      Account Readiness Profiles — AI-scored signals on whether an account is
      ready for outreach or expansion, computed via a Temporal workflow.
  - name: Integrations
    description: >-
      Pipedream Connect — issuing connect tokens and managing the org's
      connected third-party accounts.
  - name: Feedback
    description: >-
      User-submitted platform feedback (bug reports, feature requests) — global,
      not scoped to one organization.
  - name: Public Media
    description: >-
      Unauthenticated image reads for publicly-embeddable assets (card photos,
      inline email images) — allowlisted by key shape; everything else in the
      storage bucket stays private.
  - name: Service Health
    description: Service liveness.
paths:
  /deals/kpis:
    get:
      tags:
        - Deals
      summary: Get Deals Kpis
      description: >-
        Header KPI tiles, aggregated in the DB (deal_kpis view, or
        deal_kpis_search when

        `q` is set), in display shape.
      operationId: get_deals_kpis_deals_kpis_get
      parameters:
        - name: q
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: >-
              Free-text search; when set, KPIs are computed via the
              deal_kpis_search RPC instead of the deal_kpis view.
            title: Q
          description: >-
            Free-text search; when set, KPIs are computed via the
            deal_kpis_search RPC instead of the deal_kpis view.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - HTTPBearer: []
components:
  schemas:
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer

````