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

# Get the busiest rules in the window

> Use this endpoint to get up to ten rules, ordered by how often they matched in the window. For each rule, the response returns the number of validations that evaluated it, its detection rate, and the mean end-to-end latency of the validations it matched. Set the window with `period` (7d, 30d or 90d, default 30d), or with `start_date` and `end_date` (at most 90 days).



## OpenAPI

````yaml /pt/openapi/v3-current/tracer.yaml get /v1/dashboard/top-rules
openapi: 3.1.0
info:
  title: Midaz Tracer API
  description: >-
    Reference for Midaz Tracer transaction validation, fraud rules, spending
    limits, reservations, and audit events.
  version: 4.0.0
servers:
  - url: https://tracer.sandbox.lerian.net
security: []
tags:
  - name: Validations API
  - name: Rules API
  - name: Limits API
  - name: Reservations API
  - name: Audit Events API
  - name: Dashboards API
paths:
  /v1/dashboard/top-rules:
    get:
      tags:
        - Dashboards API
      summary: Get the busiest rules in the window
      description: >-
        Use this endpoint to get up to ten rules, ordered by how often they
        matched in the window. For each rule, the response returns the number of
        validations that evaluated it, its detection rate, and the mean
        end-to-end latency of the validations it matched. Set the window with
        `period` (7d, 30d or 90d, default 30d), or with `start_date` and
        `end_date` (at most 90 days).
      operationId: getDashboardTopRules
      parameters:
        - description: >-
            Relative window: 7d, 30d or 90d (default: 30d). Mutually exclusive
            with start_date/end_date.
          explode: false
          in: query
          name: period
          schema:
            description: >-
              Relative window: 7d, 30d or 90d (default: 30d). Mutually exclusive
              with start_date/end_date.
            type: string
        - description: >-
            Window start (RFC3339). Requires end_date. Mutually exclusive with
            period.
          explode: false
          in: query
          name: start_date
          schema:
            description: >-
              Window start (RFC3339). Requires end_date. Mutually exclusive with
              period.
            type: string
        - description: >-
            Window end (RFC3339), exclusive. Requires start_date. Window may not
            exceed 90 days.
          explode: false
          in: query
          name: end_date
          schema:
            description: >-
              Window end (RFC3339), exclusive. Requires start_date. Window may
              not exceed 90 days.
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DashboardTopRules'
          description: OK
          headers:
            Cache-Control:
              schema:
                type: string
        '422':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Unprocessable Entity
        '500':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Internal Server Error
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Error
      security:
        - BearerAuth: []
        - ApiKeyAuth: []
components:
  schemas:
    DashboardTopRules:
      additionalProperties: false
      properties:
        rules:
          items:
            $ref: '#/components/schemas/TopRule'
          type:
            - array
            - 'null'
        updatedAt:
          format: date-time
          type: string
        windowEnd:
          format: date-time
          type: string
        windowStart:
          format: date-time
          type: string
      required:
        - rules
        - windowStart
        - windowEnd
        - updatedAt
      type: object
    Error:
      additionalProperties: true
      properties:
        code:
          description: >-
            Stable, machine-readable domain error code scoped to the emitting
            service (format: <SERVICE>-NNNN).
          type: string
        detail:
          description: >-
            A human-readable explanation specific to this occurrence of the
            problem.
          examples:
            - Property foo is required but is missing.
          type: string
        errors:
          description: Optional list of individual error details
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type:
            - array
            - 'null'
        instance:
          description: >-
            A URI reference that identifies the specific occurrence of the
            problem.
          examples:
            - https://example.com/error-log/abc123
          format: uri
          type: string
        status:
          description: HTTP status code
          examples:
            - 400
          format: int64
          type: integer
        title:
          description: >-
            A short, human-readable summary of the problem type. This value
            should not change between occurrences of the error.
          examples:
            - Bad Request
          type: string
        type:
          default: about:blank
          description: A URI reference to human-readable documentation for the error.
          examples:
            - https://example.com/errors/example
          format: uri
          type: string
        upstream:
          $ref: '#/components/schemas/Upstream'
          description: >-
            RFC 9457 extension member: the error a proxied third-party provider
            reported. Absent unless the emitting service explicitly surfaced
            one.
      type: object
    TopRule:
      additionalProperties: false
      properties:
        avgProcessingMs:
          examples:
            - 41.2
          format: double
          type: number
        detectionRate:
          examples:
            - 0.063
          format: double
          type: number
        executions:
          examples:
            - 20536
          format: int64
          type: integer
        matches:
          examples:
            - 1287
          format: int64
          type: integer
        name:
          examples:
            - high-value-wire
          type: string
        productType:
          examples:
            - WIRE
          type: string
      required:
        - name
        - matches
        - executions
        - detectionRate
        - avgProcessingMs
      type: object
    ErrorDetail:
      additionalProperties: false
      properties:
        location:
          description: >-
            Where the error occurred, e.g. 'body.items[3].tags' or
            'path.thing-id'
          type: string
        message:
          description: Error message text
          type: string
        value:
          description: The value at the given location
      type: object
    Upstream:
      additionalProperties: false
      properties:
        code:
          description: The upstream provider's own error code, verbatim.
          examples:
            - E4001
          type: string
        message:
          description: >-
            The upstream provider's own error message, verbatim (bounded, never
            its raw response body).
          examples:
            - account not found at provider
          type: string
      type: object
  securitySchemes:
    BearerAuth:
      bearerFormat: JWT
      description: JWT bearer token issued by the identity provider.
      scheme: bearer
      type: http
    ApiKeyAuth:
      description: Static API key presented in the X-API-Key header.
      in: header
      name: X-API-Key
      type: apiKey

````