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

# Explain a job in a filter

> Says why a job is or is not in a filter: the criteria that exclude it, and other reasons such as a hide or an AI disqualification. Counts against the daily explain_job cap



## OpenAPI

````yaml get /filters/{id}/explain
openapi: 3.0.4
info:
  title: Vollna API
  description: API for managing Upwork profiles, proposals, results, and filters
  version: 1.0.0
servers:
  - url: https://api.vollna.com/v1
security: []
tags:
  - name: Profiles
    description: Manage Upwork profiles
  - name: Proposals
    description: Access and manage Upwork proposals
  - name: Results
    description: View monitoring results and projects
  - name: Filters
    description: Manage monitoring filters
  - name: Auto Bidding
    description: Manage auto bidding jobs and setups
  - name: Account
    description: The token team's account, plan and meters
  - name: Invitations
    description: Upwork invitations
  - name: Projects
    description: Upwork jobs and their competition
  - name: AI Qualifier
    description: A filter's AI qualifier and its verdicts
  - name: Market Insights
    description: Upwork market analytics and saved searches
  - name: Proposal Templates
    description: Proposal templates and their results
paths:
  /filters/{id}/explain:
    get:
      tags:
        - Filters
      summary: Explain a job in a filter
      description: >-
        Says why a job is or is not in a filter: the criteria that exclude it,
        and other reasons such as a hide or an AI disqualification. Counts
        against the daily explain_job cap
      parameters:
        - name: id
          in: path
          description: Filter ID
          required: true
          schema:
            type: integer
        - name: job
          in: query
          required: true
          description: A Vollna project id, an Upwork job URL or ciphertext, or a job title
          schema:
            type: string
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      candidates:
                        type: array
                        description: >-
                          One entry per job the reference names; a title can
                          match up to 6 jobs
                        items:
                          type: object
                          properties:
                            projectId:
                              type: integer
                            title:
                              type: string
                            url:
                              type: string
                            indexed:
                              type: boolean
                              description: >-
                                false when the job never reached the search
                                index, so no filter can show it
                            inFilter:
                              type: boolean
                            criteriaReasons:
                              type: array
                              description: Criteria that exclude the job
                              items:
                                type: object
                                properties:
                                  key:
                                    type: string
                                  label:
                                    type: string
                                  detail:
                                    type: string
                            otherReasons:
                              type: array
                              description: Hides, AI verdicts and other reasons
                              items:
                                type: object
                                properties:
                                  key:
                                    type: string
                                  label:
                                    type: string
                                  detail:
                                    type: string
                      note:
                        type: string
                        description: Set when no job matched
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '402':
          $ref: '#/components/responses/PaymentRequired'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          description: The daily explain_job cap is used up, or the rate limit is reached
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
      security:
        - apiToken: []
components:
  responses:
    BadRequest:
      description: >-
        Invalid request. message says what to send instead; fields names each
        invalid field
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ServiceError'
    Unauthorized:
      description: Missing or unknown API token
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    PaymentRequired:
      description: The team's subscription is not active
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Forbidden:
      description: >-
        The plan has no API access, or the token team may not do this. message
        says why
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ServiceError'
    NotFound:
      description: Not found in the token's team
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ServiceError'
  schemas:
    ServiceError:
      type: object
      properties:
        error:
          type: string
          description: Short error title
          example: Validation failed
        message:
          type: string
          description: What went wrong and what to send instead, written for the user
        fields:
          type: object
          description: >-
            Per-field messages keyed by dot path, when several fields fail at
            once
          additionalProperties:
            type: string
    Error:
      type: object
      properties:
        error:
          type: string
  securitySchemes:
    apiToken:
      type: apiKey
      name: X-API-TOKEN
      in: header
      description: API token for authentication

````

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