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

# Overlay-dismissal events

> Returns a paginated, filterable list of overlay-dismissal events for the scoped project.



## OpenAPI

````yaml /api-reference/openapi.generated.json get /api/v1/telemetry/overlay-dismissals/events
openapi: 3.1.0
info:
  title: Empirical API
  version: 1.0.0
  description: Programmatic access to Empirical test runs, snoozes, and more.
  contact:
    name: Empirical
    url: https://empirical.run
servers:
  - url: https://api.empirical.run
security:
  - Bearer: []
tags:
  - name: Analytics
    description: Aggregated test-run, test-count and test-case analytics for a project.
  - name: Analytics (Deprecated)
    description: >-
      Legacy analytics endpoints retained for backwards compatibility; prefer
      the v2 equivalents.
  - name: Environments
    description: >-
      Named deployment targets (slug + Playwright project filters) a project's
      tests run against.
  - name: Snoozes
    description: Temporarily suppress known test failures for specific Playwright tests.
  - name: Telemetry
    description: Product telemetry derived from analytics events, scoped to a project.
  - name: Test Cases
    description: >-
      Browse the Playwright test cases synced from a project's repository and
      manage their tags.
paths:
  /api/v1/telemetry/overlay-dismissals/events:
    get:
      tags:
        - Telemetry
      summary: Overlay-dismissal events
      description: >-
        Returns a paginated, filterable list of overlay-dismissal events for the
        scoped project.
      operationId: getOverlayDismissalEvents
      parameters:
        - schema:
            type: string
            description: Page number (1-indexed). Default 1.
          required: false
          description: Page number (1-indexed). Default 1.
          name: page
          in: query
        - schema:
            type: string
            description: Items per page (1-100). Default 50.
          required: false
          description: Items per page (1-100). Default 50.
          name: per_page
          in: query
        - schema:
            type: string
            description: >-
              Look-back window in days (1-90, default 7). Ignored when
              `start_date` and `end_date` are set.
          required: false
          description: >-
            Look-back window in days (1-90, default 7). Ignored when
            `start_date` and `end_date` are set.
          name: days
          in: query
        - schema:
            type: string
            description: Start of a custom date range (ISO 8601).
          required: false
          description: Start of a custom date range (ISO 8601).
          name: start_date
          in: query
        - schema:
            type: string
            description: End of a custom date range (ISO 8601).
          required: false
          description: End of a custom date range (ISO 8601).
          name: end_date
          in: query
        - schema:
            type: string
            description: Filter by environment name.
          required: false
          description: Filter by environment name.
          name: environment
          in: query
        - schema:
            type: string
            description: Filter by test run ID.
          required: false
          description: Filter by test run ID.
          name: test_run_id
          in: query
        - schema:
            type: string
            description: Case-insensitive substring filter on test name.
          required: false
          description: Case-insensitive substring filter on test name.
          name: test_name
          in: query
        - schema:
            type: string
            description: 'Filter by success: `true` or `false`. Other values ignored.'
          required: false
          description: 'Filter by success: `true` or `false`. Other values ignored.'
          name: success
          in: query
        - schema:
            type: string
            description: 'Filter by cache hit: `true` or `false`. Other values ignored.'
          required: false
          description: 'Filter by cache hit: `true` or `false`. Other values ignored.'
          name: cache_hit
          in: query
      responses:
        '200':
          description: Paginated overlay-dismissal events for the project.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OverlayDismissalEventsResponse'
        '500':
          description: Failed to query telemetry.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    OverlayDismissalEventsResponse:
      type: object
      properties:
        data:
          type: object
          properties:
            project:
              $ref: '#/components/schemas/TelemetryProjectRef'
            events:
              type: array
              items:
                $ref: '#/components/schemas/OverlayDismissalEvent'
              description: The page of overlay-dismissal events.
          required:
            - project
            - events
          description: Project reference and the page of events.
        pagination:
          $ref: '#/components/schemas/Pagination'
      required:
        - data
        - pagination
    ErrorResponse:
      type: object
      properties:
        data:
          nullable: true
          description: Always null for error responses.
        error:
          type: object
          properties:
            message:
              type: string
              description: Human-readable error message.
          required:
            - message
          description: Error details.
      required:
        - data
        - error
    TelemetryProjectRef:
      type: object
      properties:
        id:
          type: integer
          description: Project ID.
        name:
          type: string
          nullable: true
          description: Project name.
        repo_name:
          type: string
          nullable: true
          description: Repository name backing the project.
      required:
        - id
        - name
        - repo_name
    OverlayDismissalEvent:
      type: object
      properties:
        timestamp:
          type: string
          description: ISO 8601 timestamp of the event.
        environment:
          type: string
          nullable: true
          description: Environment the test ran in.
        repo_name:
          type: string
          nullable: true
          description: Repository the test belongs to.
        project_name:
          type: string
          nullable: true
          description: Project name.
        test_run_id:
          type: string
          nullable: true
          description: ID of the test run.
        test_name:
          type: string
          nullable: true
          description: Name of the test.
        success:
          type: boolean
          nullable: true
          description: Whether the dismissal succeeded.
        cache_hit:
          type: boolean
          nullable: true
          description: Whether the result was served from cache.
        duration_ms:
          type: number
          nullable: true
          description: Dismissal duration in milliseconds.
        overlay_description:
          type: string
          nullable: true
          description: Description of the dismissed overlay.
        overlay_text:
          type: string
          nullable: true
          description: Visible text of the dismissed overlay.
        original_locator:
          type: string
          nullable: true
          description: Original locator that was occluded.
        tokens_input:
          type: number
          nullable: true
          description: Input tokens consumed.
        tokens_output:
          type: number
          nullable: true
          description: Output tokens produced.
        cost_input:
          type: number
          nullable: true
          description: Cost of input tokens.
        cost_output:
          type: number
          nullable: true
          description: Cost of output tokens.
      required:
        - timestamp
        - environment
        - repo_name
        - project_name
        - test_run_id
        - test_name
        - success
        - cache_hit
        - duration_ms
        - overlay_description
        - overlay_text
        - original_locator
        - tokens_input
        - tokens_output
        - cost_input
        - cost_output
    Pagination:
      type: object
      properties:
        page:
          type: integer
          description: Current page (1-indexed).
        per_page:
          type: integer
          description: Items per page.
        total:
          type: integer
          description: Total number of items.
        total_pages:
          type: integer
          description: Total number of pages.
      required:
        - page
        - per_page
        - total
        - total_pages
      description: Pagination metadata.
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer

````