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

# List prompt matches

> Returns the best page of the site for each tracked prompt, with the match quality. The list is paged with `page` and `page_size`.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/sites/{site_uuid}/content/matches
openapi: 3.0.3
info:
  title: Perquery API
  version: 1.0.0
  description: Read-only access to the data of your Perquery organization.
servers:
  - url: https://perquery.ai/api
security:
  - apiKey: []
paths:
  /v1/sites/{site_uuid}/content/matches:
    get:
      tags:
        - Content analysis
      summary: List prompt matches
      description: >-
        Returns the best page of the site for each tracked prompt, with the
        match quality. The list is paged with `page` and `page_size`.
      operationId: list_matches
      parameters:
        - in: query
          name: page
          schema:
            type: integer
            minimum: 1
            default: 1
        - in: query
          name: page_size
          schema:
            type: integer
            maximum: 100
            minimum: 1
            default: 50
        - in: path
          name: site_uuid
          schema:
            type: string
            format: uuid
          required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MatchList'
          description: ''
      security:
        - apiKey: []
components:
  schemas:
    MatchList:
      type: object
      properties:
        matches:
          type: array
          items:
            $ref: '#/components/schemas/MatchRow'
        total:
          type: integer
          default: 0
        page:
          type: integer
          default: 1
        page_size:
          type: integer
          default: 0
      required:
        - matches
    MatchRow:
      type: object
      properties:
        prompt_uuid:
          type: string
        prompt_text:
          type: string
        page_path:
          type: string
          nullable: true
        page_url:
          type: string
          nullable: true
        state:
          $ref: '#/components/schemas/MatchState'
        strength:
          nullable: true
          allOf:
            - $ref: '#/components/schemas/MatchStrength'
        reason:
          type: string
        retrieval_mode:
          nullable: true
          allOf:
            - $ref: '#/components/schemas/RetrievalMode'
        is_outdated:
          type: boolean
        target_read:
          allOf:
            - $ref: '#/components/schemas/TargetRead'
          nullable: true
      required:
        - is_outdated
        - page_path
        - page_url
        - prompt_text
        - prompt_uuid
        - reason
        - retrieval_mode
        - state
        - strength
        - target_read
    MatchState:
      enum:
        - strong
        - weak
        - none
        - not_analysed
        - target_pending
        - target_unreadable
      type: string
      description: |-
        * `strong` - strong
        * `weak` - weak
        * `none` - none
        * `not_analysed` - not_analysed
        * `target_pending` - target_pending
        * `target_unreadable` - target_unreadable
    MatchStrength:
      enum:
        - strong
        - weak
        - none
      type: string
      description: |-
        * `strong` - strong
        * `weak` - weak
        * `none` - none
    RetrievalMode:
      enum:
        - semantic
        - lexical
      type: string
      description: |-
        * `semantic` - semantic
        * `lexical` - lexical
    TargetRead:
      type: object
      description: The last read of a target page that gave no page.
      properties:
        outcome:
          $ref: '#/components/schemas/TargetReadOutcome'
        status_code:
          type: integer
          nullable: true
        final_url:
          type: string
          nullable: true
        is_permanent:
          type: boolean
        read_at:
          type: string
          format: date-time
      required:
        - final_url
        - is_permanent
        - outcome
        - read_at
        - status_code
    TargetReadOutcome:
      enum:
        - ok
        - http_error
        - not_html
        - empty
        - unreachable
        - rate_limited
        - redirected
        - robots_blocked
      type: string
      description: |-
        * `ok` - ok
        * `http_error` - http_error
        * `not_html` - not_html
        * `empty` - empty
        * `unreachable` - unreachable
        * `rate_limited` - rate_limited
        * `redirected` - redirected
        * `robots_blocked` - robots_blocked
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: Authorization
      description: '`ApiKey pq_<prefix>_<secret>`. An API key gives read-only access.'

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.