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

# Funnel, pages, sources and conversation quality

> Requires the `analytics:read` scope.



## OpenAPI

````yaml /api-reference/openapi.json get /analytics
openapi: 3.1.0
info:
  title: Darwin API
  version: '2026-10-12'
  description: >-
    Read and act on your Darwin workspace: conversations, contacts, meetings,
    analytics, knowledge, the agent and its opening tests, with signed webhooks
    for what happens.


    Authenticate with a secret key from Integrations → API: `Authorization:
    Bearer dk_live_…`. Keys carry scopes; personal data needs `contacts:read`.

    Rate limits are per key per minute: origin 120, adapt 120, evolve 600, apex
    1200; heavy calls (exports, crawls, model work) have a smaller budget. Every
    response carries RateLimit-* headers.

    Lists are cursor-paginated (`limit`, `starting_after`, `next_cursor`).
    Writes accept `Idempotency-Key`. Errors are RFC 9457 problem documents with
    a stable `code` and a `request_id`.
  contact:
    name: Darwin
    url: https://docs.meetdarwin.ai/api-reference/introduction
servers:
  - url: https://api.meetdarwin.ai/v1
security:
  - bearer: []
tags:
  - name: Workspace
  - name: Conversations
  - name: Contacts
  - name: Meetings
  - name: Analytics
  - name: Events
  - name: Webhooks
  - name: Knowledge
  - name: Agent
  - name: Experiments
  - name: Privacy
  - name: Chat
paths:
  /analytics:
    get:
      tags:
        - Analytics
      summary: Funnel, pages, sources and conversation quality
      description: Requires the `analytics:read` scope.
      operationId: getAnalytics
      parameters:
        - name: range
          in: query
          required: false
          description: 7d, 14d, 30d (default) or 90d.
          schema:
            type: string
            enum:
              - 7d
              - 14d
              - 30d
              - 90d
        - name: page
          in: query
          required: false
          description: One page.
          schema:
            type: string
        - name: source
          in: query
          required: false
          description: One source label.
          schema:
            type: string
        - name: device
          in: query
          required: false
          description: desktop or mobile.
          schema:
            type: string
            enum:
              - desktop
              - mobile
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Analytics'
        '400':
          description: Invalid request (`invalid_request`, `unsupported_version`).
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '401':
          description: >-
            Missing or invalid key (`authentication_required`,
            `invalid_api_key`).
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '402':
          description: >-
            The workspace must add a card before the API can be used
            (`payment_required`).
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: The key lacks the scope (`insufficient_scope`).
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: No such object in this workspace (`not_found`).
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '409':
          description: >-
            Conflicts with the current state (`conflict`,
            `idempotency_key_in_use`).
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '422':
          description: Refused by a rule (`unprocessable`, `idempotency_key_reused`).
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: >-
            Rate limited (`rate_limited`) or a monthly allowance used
            (`quota_exceeded`); see Retry-After.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
components:
  schemas:
    Analytics:
      type: object
      properties:
        object:
          type: string
          const: analytics
        range:
          type: string
          enum:
            - 7d
            - 14d
            - 30d
            - 90d
        filters:
          type: object
          properties:
            page:
              type:
                - string
                - 'null'
            source:
              type:
                - string
                - 'null'
            device:
              type:
                - string
                - 'null'
          required:
            - page
            - source
            - device
        window:
          type: object
          properties:
            from:
              type: string
            to:
              type: string
            previous_from:
              type: string
          required:
            - from
            - to
            - previous_from
        headline:
          type: array
          items:
            type: object
            properties:
              metric:
                type: string
                enum:
                  - visitors
                  - teaser_shown
                  - chat_opened
                  - conversations
                  - leads
                  - meetings
              value:
                type: number
              previous:
                type: number
              series:
                type: array
                items:
                  type: object
                  properties:
                    day:
                      type: string
                    value:
                      type: number
                  required:
                    - day
                    - value
            required:
              - metric
              - value
              - previous
              - series
        funnel:
          type: array
          items:
            type: object
            properties:
              stage:
                type: string
              label:
                type: string
              visitors:
                type: number
              rate_from_previous:
                type:
                  - number
                  - 'null'
            required:
              - stage
              - label
              - visitors
              - rate_from_previous
        biggest_drop:
          anyOf:
            - type: object
              properties:
                from:
                  type: string
                to:
                  type: string
                lost:
                  type: number
                rate:
                  type: number
              required:
                - from
                - to
                - lost
                - rate
            - type: 'null'
        by_day:
          type: array
          items:
            type: object
            properties:
              day:
                type: string
              visitors:
                type: number
              leads:
                type: number
              meetings:
                type: number
            required:
              - day
              - visitors
              - leads
              - meetings
        pages:
          type: array
          items:
            type: object
            properties:
              label:
                type: string
              visitors:
                type: number
              openings_seen:
                type: number
              chats_opened:
                type: number
              conversations:
                type: number
              leads:
                type: number
              meetings:
                type: number
            required:
              - label
              - visitors
              - openings_seen
              - chats_opened
              - conversations
              - leads
              - meetings
        sources:
          type: array
          items:
            type: object
            properties:
              label:
                type: string
              visitors:
                type: number
              openings_seen:
                type: number
              chats_opened:
                type: number
              conversations:
                type: number
              leads:
                type: number
              meetings:
                type: number
              ai_assistant:
                type: boolean
            required:
              - label
              - visitors
              - openings_seen
              - chats_opened
              - conversations
              - leads
              - meetings
              - ai_assistant
        devices:
          type: array
          items:
            type: object
            properties:
              label:
                type: string
              count:
                type: number
            required:
              - label
              - count
        returning:
          type: array
          items:
            type: object
            properties:
              label:
                type: string
              count:
                type: number
            required:
              - label
              - count
        conversation_quality:
          type: object
          properties:
            graded:
              type: number
            understood_rate:
              type:
                - number
                - 'null'
            average_qualification:
              type:
                - number
                - 'null'
            average_meeting_intent:
              type:
                - number
                - 'null'
            needs_review:
              type: number
          required:
            - graded
            - understood_rate
            - average_qualification
            - average_meeting_intent
            - needs_review
        intents:
          type: array
          items:
            type: object
            properties:
              label:
                type: string
              count:
                type: number
            required:
              - label
              - count
        buying_stages:
          type: array
          items:
            type: object
            properties:
              label:
                type: string
              count:
                type: number
            required:
              - label
              - count
        failures:
          type: array
          items:
            type: object
            properties:
              label:
                type: string
              count:
                type: number
            required:
              - label
              - count
      required:
        - object
        - range
        - filters
        - window
        - headline
        - funnel
        - biggest_drop
        - by_day
        - pages
        - sources
        - devices
        - returning
        - conversation_quality
        - intents
        - buying_stages
        - failures
    Problem:
      type: object
      properties:
        type:
          type: string
          example: https://docs.meetdarwin.ai/api-reference/errors#insufficient_scope
        title:
          type: string
        status:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
        code:
          type: string
          example: insufficient_scope
        detail:
          type: string
        param:
          type: string
        request_id:
          type: string
          example: req_8m2k4p0q1x7z9c3v5b6n
      required:
        - type
        - title
        - status
        - code
        - detail
        - request_id
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      description: >-
        A secret key (dk_live_…). Scopes: conversations:read, contacts:read,
        contacts:write, meetings:read, analytics:read, events:read,
        webhooks:write, knowledge:read, knowledge:write, agent:read,
        agent:write, experiments:read, experiments:write, privacy:write,
        chat:write.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.