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

# Screening summary



## OpenAPI

````yaml openapi/watchlist.yaml get /watchlist/analytics/summary
openapi: 3.0.3
info:
  title: TXCloud Watchlist API
  version: 1.0.0
  description: >
    AML/CFT screening against global sanctions lists, PEP databases, and adverse
    media.
servers:
  - url: https://api.txcloud.io/v1
  - url: https://sandbox.api.txcloud.io/v1
security:
  - BearerAuth: []
tags:
  - name: Screening
    description: Entity screening
  - name: Matches
    description: Match management
  - name: Monitoring
    description: Ongoing monitoring
  - name: Lists
    description: Watchlist management
  - name: Analytics
    description: Screening analytics
paths:
  /watchlist/analytics/summary:
    get:
      tags:
        - Analytics
      summary: Screening summary
      operationId: getWatchlistSummary
      responses:
        '200':
          description: Summary
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WatchlistSummary'
components:
  schemas:
    WatchlistSummary:
      type: object
      properties:
        period:
          type: string
        screenings:
          type: object
          properties:
            total:
              type: integer
            clear:
              type: integer
            potential_matches:
              type: integer
            confirmed_hits:
              type: integer
        hit_rate:
          type: number
        false_positive_rate:
          type: number
        by_list:
          type: object
        pending_review:
          type: integer
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer

````