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

# Get match stats

> Matches the Subscriptions of the key's Organization committed over the window, per evaluator plugin, in the buckets of getPluginCallStats. A Match that corrects an earlier one on a new Version of the same Record counts too. Requires observability:read on a key that grants every Corpus.



## OpenAPI

````yaml /openapi.yaml get /v0/admin/stats/matches
openapi: 3.1.0
info:
  title: Quivr HTTP API
  version: 0.0.0-draft
  description: >-
    Every endpoint of the Quivr v0 HTTP API. Send an API key as a bearer token;
    the key decides the Organization, the actions and the Corpora a request may
    reach.
servers: []
security:
  - ApiKey: []
paths:
  /v0/admin/stats/matches:
    get:
      tags:
        - Admin
      summary: Get match stats
      description: >-
        Matches the Subscriptions of the key's Organization committed over the
        window, per evaluator plugin, in the buckets of getPluginCallStats. A
        Match that corrects an earlier one on a new Version of the same Record
        counts too. Requires observability:read on a key that grants every
        Corpus.
      operationId: getMatchStats
      parameters:
        - name: window
          in: query
          required: false
          schema:
            type: string
            enum:
              - 1h
              - 24h
              - 7d
            default: 1h
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MatchStatsList'
        default:
          description: >-
            Structured error; 401 unauthenticated, 403 without
            observability:read on every Corpus, 422 invalid_window, 503 storage
            unavailable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    MatchStatsList:
      type: object
      additionalProperties: false
      properties:
        window:
          $ref: '#/components/schemas/StatsWindowName'
        resolution_seconds:
          type: integer
          minimum: 1
        from:
          type: string
          format: date-time
        to:
          type: string
          format: date-time
        total:
          type: integer
          minimum: 0
          description: Matches of every evaluator.
        items:
          type: array
          description: Most Matches first.
          items:
            $ref: '#/components/schemas/MatchStats'
      required:
        - window
        - resolution_seconds
        - from
        - to
        - total
        - items
    Error:
      type: object
      additionalProperties: false
      properties:
        code:
          type: string
          minLength: 1
        message:
          type: string
          minLength: 1
        retryable:
          type: boolean
        field:
          type: string
          minLength: 1
          description: >-
            JSON Pointer (RFC 6901) to the request member that caused a 422,
            when known (for example /config/url or /credential/secret/token on
            connector commands).
        resync_url:
          type: string
          format: uri-reference
      required:
        - code
        - message
        - retryable
    StatsWindowName:
      type: string
      enum:
        - 1h
        - 24h
        - 7d
    MatchStats:
      type: object
      additionalProperties: false
      properties:
        evaluator:
          type: string
          minLength: 1
          description: Plugin id of the evaluator of the Subscriptions that matched.
        count:
          type: integer
          minimum: 1
        points:
          type: array
          description: Non-empty buckets, oldest first.
          items:
            $ref: '#/components/schemas/CountPoint'
      required:
        - evaluator
        - count
        - points
    CountPoint:
      type: object
      additionalProperties: false
      description: >-
        One non-empty bucket, starting at start and lasting the list's
        resolution_seconds.
      properties:
        start:
          type: string
          format: date-time
        count:
          type: integer
          minimum: 1
      required:
        - start
        - count
  securitySchemes:
    ApiKey:
      type: http
      scheme: bearer
      description: >-
        API key, not necessarily a JWT. Server derives Organization, permitted
        actions and Corpus scope; every resource access is authorized.

````