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

# List top-of-funnel events

> Return pseudonymous action-click and lead-submission events for funnel reporting.

Requires `analytics:read`.

Filter by an ISO 8601 `date_from` and `date_to`, then paginate with `limit` and
`offset`. Results contain pseudonymous events that help measure drop-off before
a prospect submits an email address.


## OpenAPI

````yaml api-reference/openapi.json GET /api/v1/funnel-events
openapi: 3.1.0
info:
  title: Hobbes API
  description: >

    Use the Hobbes API to read your organization's analyzed demo sessions,

    prospects, accounts, transcripts, and funnel metrics; create and manage

    personalized Custom Links; and, with explicit elevated scopes, inspect or
    update

    the structured Playbook and publish an exact staged agent version.


    **Authentication**: create an API key in Settings → API Keys, then send it

    as `Authorization: Bearer <key>` (or `x-api-key: <key>`). Keys are

    org-scoped; responses only ever contain your organization's data.


    **Scopes**: keys carry scopes (`sessions:read`, `people:read`,

    `accounts:read`, `analytics:read`, `transcripts:read`, `custom_links:read`,

    `custom_links:write`, `playbook:read`, `playbook:write`, `agent:publish`).

    `custom_links:write` also satisfies Custom Link read access. Raw transcript,

    Playbook, and publish access are separate opt-ins. Existing API keys do not

    receive new scopes automatically. Playbook writes are preview-first;
    production

    publishing requires the literal REST confirmation value documented by the

    endpoint and runs asynchronously through Hobbes' conversation-test gate.


    **Rate limits**: keys allow 120 requests per minute by default. Responses

    include `X-RateLimit-Limit` and `X-RateLimit-Remaining`; 429 responses
    include

    `Retry-After`. Transcript access has a separate quota of 2,000 reads per

    organization per UTC day. Custom Link mutations are limited to 10 requests
    per

    minute per organization. Creation and thumbnail rendering also use weighted

    hourly and daily organization quotas, so one request containing 500 links is

    one HTTP request but consumes up to 500 creation and 500 render units.


    **Support**: every response carries an `X-Request-ID` header. Include it
    when

    reporting an issue so we can find the exact request in our logs.


    **Stability**: changes within v1 are additive only. Fields may be added to

    responses; existing fields are never removed or renamed.
  version: 1.0.0
servers:
  - url: https://api-us.hihobbes.com
    description: Production
security:
  - bearer: []
  - apiKeyHeader: []
tags:
  - name: Sessions
    description: Analyzed demo sessions and their transcripts.
  - name: People
    description: Prospect profiles aggregated across sessions.
  - name: Accounts
    description: Company-level engagement rollups by email domain.
  - name: Metrics
    description: Aggregate funnel performance over a trailing window.
  - name: Custom Links
    description: Create and manage personalized links.
  - name: Custom Link Jobs
    description: Poll, cancel, and retry asynchronous Custom Link work.
  - name: Custom Link Campaigns
    description: Organize Custom Links into campaigns.
  - name: Playbook
    description: Inspect, preview, and apply structured Playbook changes.
  - name: Agent Publishing
    description: Publish an exact staged agent version asynchronously.
paths:
  /api/v1/funnel-events:
    get:
      tags:
        - Metrics
      summary: List top-of-funnel events
      description: >-
        Return paginated, pseudonymous action-click and lead-submission events
        for exact pre-email drop-off reporting.
      operationId: v1_list_funnel_events
      parameters:
        - name: date_from
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                format: date-time
              - type: 'null'
            description: Filter by event time (ISO 8601)
            title: Date From
          description: Filter by event time (ISO 8601)
        - name: date_to
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                format: date-time
              - type: 'null'
            description: Filter by event time (ISO 8601)
            title: Date To
          description: Filter by event time (ISO 8601)
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            maximum: 200
            minimum: 1
            default: 200
            title: Limit
            description: Number of records to return. Defaults to 50 and cannot exceed 200.
          description: Number of records to return. Defaults to 50 and cannot exceed 200.
        - name: offset
          in: query
          required: false
          schema:
            type: integer
            maximum: 1000000
            minimum: 0
            default: 0
            title: Offset
            description: >-
              Zero-based number of records to skip. Use with `pagination.total`
              to request the next page.
          description: >-
            Zero-based number of records to skip. Use with `pagination.total` to
            request the next page.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FunnelEventsResponse'
          headers:
            X-Request-ID:
              description: Unique request identifier to include in support requests.
              schema:
                type: string
                example: req_01JABCDEF23456789
            X-RateLimit-Limit:
              description: Request limit for this key in the current 60-second window.
              schema:
                type: integer
                example: 120
            X-RateLimit-Remaining:
              description: Requests remaining for this key in the current window.
              schema:
                type: integer
                example: 119
        '401':
          description: API key required or invalid.
          headers:
            X-Request-ID:
              description: Unique request identifier to include in support requests.
              schema:
                type: string
                example: req_01JABCDEF23456789
          content:
            application/json:
              schema:
                type: object
                required:
                  - detail
                properties:
                  detail:
                    type: string
                    example: API key required or invalid.
        '403':
          description: API key does not include the required scope.
          headers:
            X-Request-ID:
              description: Unique request identifier to include in support requests.
              schema:
                type: string
                example: req_01JABCDEF23456789
          content:
            application/json:
              schema:
                type: object
                required:
                  - detail
                properties:
                  detail:
                    type: string
                    example: API key does not include the required scope.
        '422':
          description: A path, query, header, or request field failed validation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          headers:
            X-Request-ID:
              description: Unique request identifier to include in support requests.
              schema:
                type: string
                example: req_01JABCDEF23456789
        '429':
          description: Rate limit or organization quota exceeded.
          headers:
            X-Request-ID:
              description: Unique request identifier to include in support requests.
              schema:
                type: string
                example: req_01JABCDEF23456789
            X-RateLimit-Limit:
              description: Request limit for this key in the current 60-second window.
              schema:
                type: integer
                example: 120
            X-RateLimit-Remaining:
              description: Requests remaining for this key in the current window.
              schema:
                type: integer
                example: 119
            Retry-After:
              description: Seconds to wait before retrying.
              schema:
                type: integer
                example: 30
            X-RateLimit-Reset:
              description: Unix timestamp when the limiting window resets.
              schema:
                type: integer
          content:
            application/json:
              schema:
                type: object
                required:
                  - detail
                properties:
                  detail:
                    type: string
                    example: Rate limit or organization quota exceeded.
components:
  schemas:
    FunnelEventsResponse:
      properties:
        events:
          items:
            $ref: '#/components/schemas/FunnelEventItem'
          type: array
          title: Events
        pagination:
          $ref: '#/components/schemas/Pagination'
      type: object
      required:
        - events
        - pagination
      title: FunnelEventsResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    FunnelEventItem:
      properties:
        id:
          type: string
          title: Id
          description: Stable Hobbes funnel event UUID.
        eventType:
          type: string
          enum:
            - start_demo_clicked
            - lead_submitted
          title: Eventtype
          description: Top-of-funnel event represented by this row.
        occurredAt:
          type: string
          format: date-time
          title: Occurredat
          description: Canonical client event timestamp in ISO 8601 format.
        visitorId:
          anyOf:
            - type: string
            - type: 'null'
          title: Visitorid
          description: >-
            Pseudonymous browser visitor identifier. No email or other PII is
            returned.
        pageViewId:
          anyOf:
            - type: string
            - type: 'null'
          title: Pageviewid
          description: Page-view identifier used to match a click to its email submission.
        widgetSessionId:
          anyOf:
            - type: string
            - type: 'null'
          title: Widgetsessionid
          description: Demo-attempt identifier, when available.
        callId:
          anyOf:
            - type: string
            - type: 'null'
          title: Callid
          description: Hobbes call identifier, when the attempt started.
        sessionRecordingId:
          anyOf:
            - type: string
            - type: 'null'
          title: Sessionrecordingid
          description: Hobbes session recording identifier, when the attempt started.
      type: object
      required:
        - id
        - eventType
        - occurredAt
      title: FunnelEventItem
    Pagination:
      properties:
        total:
          type: integer
          title: Total
          description: Total records matching the request.
          examples:
            - 248
        limit:
          type: integer
          title: Limit
          description: Maximum records returned in this page.
          examples:
            - 50
        offset:
          type: integer
          title: Offset
          description: Zero-based number of matching records skipped.
          examples:
            - 0
      type: object
      required:
        - total
        - limit
        - offset
      title: Pagination
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      description: Hobbes API key with the `hb_live_` prefix.
    apiKeyHeader:
      type: apiKey
      in: header
      name: x-api-key
      description: Alternative to the Bearer authorization header.

````