> ## 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 summary

> Returns aggregated overlay-dismissal metrics for the scoped project.



## OpenAPI

````yaml /api-reference/openapi.generated.json get /api/v1/telemetry/overlay-dismissals
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:
    get:
      tags:
        - Telemetry
      summary: Overlay-dismissal summary
      description: Returns aggregated overlay-dismissal metrics for the scoped project.
      operationId: getOverlayDismissalSummary
      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: Overlay-dismissal summary for the project.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OverlayDismissalSummaryResponse'
        '500':
          description: Failed to query telemetry.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    OverlayDismissalSummaryResponse:
      type: object
      properties:
        data:
          type: object
          properties:
            project:
              $ref: '#/components/schemas/TelemetryProjectRef'
            summary:
              $ref: '#/components/schemas/OverlayDismissalSummary'
          required:
            - project
            - summary
          description: Response payload.
      required:
        - data
    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
    OverlayDismissalSummary:
      type: object
      properties:
        total:
          type: number
          description: Total overlay-dismissal events in the window.
        success_count:
          type: number
          description: Number of successful dismissals.
        success_rate:
          type: number
          description: Success rate as a percentage (0-100).
        cache_hit_count:
          type: number
          description: Number of dismissals served from cache.
        cache_hit_rate:
          type: number
          description: Cache-hit rate as a percentage (0-100).
        avg_duration_ms:
          type: number
          description: Average dismissal duration in milliseconds.
        total_cost:
          type: number
          description: Total cost across all dismissals.
      required:
        - total
        - success_count
        - success_rate
        - cache_hit_count
        - cache_hit_rate
        - avg_duration_ms
        - total_cost
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer

````