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

# Get session clicks

> Retrieve all click interactions from a session with before/after screenshot URLs. Includes click metadata (text, tag, CSS class) and navigation information. Screenshot URLs are time-limited (~3 hours).



## OpenAPI

````yaml GET /api/v1/sessions/{sessionId}/clicks
openapi: 3.0.3
info:
  title: Decipher API
  version: 1.0.0
  description: >-
    API for retrieving test run data from Decipher. Use your API key to
    authenticate requests.
servers:
  - url: https://api.getdecipher.com
    description: Production
security: []
paths:
  /api/v1/sessions/{sessionId}/clicks:
    get:
      summary: Get session clicks
      description: >-
        Retrieve all click interactions from a session with before/after
        screenshot URLs. Includes click metadata (text, tag, CSS class) and
        navigation information. Screenshot URLs are time-limited (~3 hours).
      parameters:
        - schema:
            type: string
            format: uuid
            description: The UUID of the session
            example: a1b2c3d4-e5f6-7890-abcd-ef1234567890
          required: true
          description: The UUID of the session
          name: sessionId
          in: path
      responses:
        '200':
          description: Session clicks with screenshot URLs
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SessionClicksResponse'
        '401':
          description: Authentication error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '404':
          description: Session not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      security:
        - bearerAuth: []
components:
  schemas:
    SessionClicksResponse:
      type: object
      properties:
        object:
          type: string
          enum:
            - sessionClicks
        sessionId:
          type: string
          format: uuid
        data:
          type: array
          items:
            $ref: '#/components/schemas/SessionClick'
        screenshotsExpiresAt:
          type: string
          nullable: true
          description: >-
            ISO timestamp when screenshot URLs expire (~3h). Null if no
            screenshots available.
      required:
        - object
        - sessionId
        - data
        - screenshotsExpiresAt
    ApiError:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              enum:
                - authentication_error
                - authorization_error
                - not_found_error
                - validation_error
                - rate_limit_error
                - api_error
            code:
              type: string
            message:
              type: string
            field:
              type: string
          required:
            - type
            - code
            - message
      required:
        - error
    SessionClick:
      type: object
      properties:
        id:
          type: number
        type:
          type: string
          description: 'Click type: click, multiClick, slowClick, deadClick'
        timestamp:
          type: number
          nullable: true
          description: Click timestamp (epoch ms)
        clickCount:
          type: number
          nullable: true
          description: Number of clicks (for multiClick)
        navigationTo:
          type: string
          nullable: true
          description: URL navigated to after this click, if any
        screenshots:
          type: object
          properties:
            before:
              type: string
              nullable: true
              description: Signed URL for screenshot taken before the click
            after:
              type: string
              nullable: true
              description: Signed URL for screenshot taken after the click
          required:
            - before
            - after
      required:
        - id
        - type
        - timestamp
        - clickCount
        - navigationTo
        - screenshots
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: API key authentication. Use your Decipher API key as the bearer token.

````