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

# Log Search Result Click

> Track when a user clicks a search result



## OpenAPI

````yaml POST /logging/search-result-clicks
openapi: 3.1.0
info:
  title: Haystack API
  description: Content management and semantic search API for Haystack
  version: 2.0.0
  contact:
    name: Haystack Support
    email: support@thehaystack.ai
    url: https://thehaystack.ai
servers:
  - url: https://api.thehaystack.ai/v2/haystack
    description: Production server
security:
  - bearerAuth: []
tags:
  - name: Items
    description: Content item management
  - name: Collections
    description: Top-level content organization
  - name: Series
    description: Multi-part content grouping
  - name: Speakers
    description: Content presenter management
  - name: Media
    description: Video and audio asset management
  - name: Search
    description: Semantic content search
  - name: Analytics
    description: Usage statistics and metrics
  - name: Resources
    description: Attach supplementary files, links, and videos to items
  - name: Scriptures
    description: Attach Bible references to items
  - name: Chapters
    description: Time-based chapter markers on media assets
  - name: Stats
    description: Analytics and reporting
  - name: Frontend
    description: Public frontend configuration
paths:
  /logging/search-result-clicks:
    post:
      tags:
        - Analytics
      summary: Log search click
      description: Track when a user clicks a search result
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - searchId
                - itemId
                - position
                - surface
              properties:
                searchId:
                  type: string
                  description: >-
                    The encoded search id returned on `GET /search` as
                    `queryAnalyticsId`
                itemId:
                  type: integer
                position:
                  type: integer
                  description: Zero-indexed position of the clicked result
                clickedHighlight:
                  type: boolean
                  description: >-
                    True if the user clicked a highlighted transcript snippet
                    rather than the item card
                surface:
                  type: string
                  enum:
                    - embed
                    - connect
                    - console
                embedToken:
                  type: string
                  description: Required when surface=embed
      responses:
        '200':
          description: Click logged
          content:
            application/json:
              schema:
                type: object
                properties:
                  clickId:
                    type: string
                    format: uuid
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Enter your API token from the Haystack dashboard

````