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

# Filter Field Values

> Get the top values by count for a single filter-search field.



## OpenAPI

````yaml https://api.sixtyfour.ai/openapi.json post /search/filter-field-values
openapi: 3.1.0
info:
  title: Sixtyfour API
  description: >-
    Intelligence API for People and Entities. Deploy AI agents that investigate,
    resolve identities, map relationships, and surface risk signals
  contact:
    name: Sixtyfour
    url: https://sixtyfour.ai/
    email: support@sixtyfour.ai
  license:
    name: Proprietary
  version: 1.0.0
servers:
  - url: https://api.sixtyfour.ai
    description: Production
security: []
tags:
  - name: Enrichment
    description: Find and enrich emails, phones, and LinkedIn for people and companies.
  - name: org-chart
    description: Discover people inside a company and build org charts.
  - name: Search
    description: Run deep and filter searches over Sixtyfour's data.
  - name: Workflow
    description: Create, run, and manage enrichment workflows.
  - name: Workflow Schedules
    description: Create and manage recurring schedules for workflows.
  - name: Account
    description: Manage and inspect your account and credit balance.
  - name: Intelligence
    description: Verify identity attributes such as age using high-tier OSINT research.
paths:
  /search/filter-field-values:
    post:
      tags:
        - Search
      summary: Filter Field Values
      description: Get the top values by count for a single filter-search field.
      operationId: filter_field_values_endpoint_search_filter_field_values_post
      parameters:
        - name: x-api-key
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: X-Api-Key
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FilterFieldValuesRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterFieldValuesResponse'
        '400':
          description: Request was rejected by the route's validation rules.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
              example:
                detail: Invalid request body
        '401':
          description: Missing or invalid API key.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
              example:
                detail: Invalid API key
        '402':
          description: >-
            Insufficient credits or no active subscription for this
            organization.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
              example:
                detail: Insufficient API credits
        '403':
          description: Forwarded user_id does not belong to caller's organization.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
              example:
                detail: Forwarded user_id does not belong to your organization.
        '404':
          description: Search task or export file not found.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
              example:
                detail: Search not found or has no parsed_query.
        '409':
          description: Export workflow already running for this search.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
              example:
                detail: Export workflow is already running for this search.
        '422':
          description: Request body failed validation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '429':
          description: Rate limit exceeded.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
              example:
                detail: Rate limit exceeded
        '500':
          description: Unexpected server error. Retry with backoff.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
              example:
                detail: Internal server error
        '502':
          description: Upstream search backend returned an error.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
              example:
                detail: 'NL upstream transport error: connection reset by peer'
        '503':
          description: Search backend is not configured or unavailable.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
              example:
                detail: Company search backend endpoint is not configured
        '504':
          description: Upstream search backend timed out.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
              example:
                detail: Field values request timed out
components:
  schemas:
    FilterFieldValuesRequest:
      properties:
        mode:
          type: string
          enum:
            - people
            - company
          title: Mode
          description: 'Search mode: ''people'' or ''company''.'
          default: company
        field:
          type: string
          title: Field
          description: Canonical field path to aggregate values for.
        top_k:
          type: integer
          maximum: 100
          minimum: 1
          title: Top K
          description: Maximum number of top values to return.
          default: 25
        filters:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Filters
          description: Raw OpenSearch DSL filters that scope the aggregation.
        simple_filters:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Simple Filters
          description: MongoDB-style filters that scope the aggregation.
      type: object
      required:
        - field
      title: FilterFieldValuesRequest
      description: Request for top values of a single field.
    FilterFieldValuesResponse:
      properties:
        mode:
          type: string
          enum:
            - people
            - company
          title: Mode
          description: 'Search mode: ''people'' or ''company''.'
          default: company
        field:
          type: string
          title: Field
          description: Field requested by the caller.
        canonical_field:
          type: string
          title: Canonical Field
          description: Canonical field path used for aggregation.
        aggregation_field:
          anyOf:
            - type: string
            - type: 'null'
          title: Aggregation Field
          description: Underlying field used for the terms aggregation.
        nested_path:
          anyOf:
            - type: string
            - type: 'null'
          title: Nested Path
          description: Nested path, if any.
        value_type:
          type: string
          title: Value Type
          description: Aggregation target type (keyword, long, etc.).
        supports_top_values:
          type: boolean
          title: Supports Top Values
          description: Whether this field supports top-values aggregation.
        supports_exact_filter_snippet:
          type: boolean
          title: Supports Exact Filter Snippet
          description: Whether the response includes deterministic filter snippets.
        related_fields:
          items:
            type: string
          type: array
          title: Related Fields
          description: >-
            Other field paths representing the same concept (e.g. flat
            counterpart of nested).
        preferred_for_exact_match:
          type: boolean
          title: Preferred For Exact Match
          description: >-
            Recommended for simple exact-match queries over its nested
            counterpart.
          default: false
        total_scoped_documents:
          type: integer
          title: Total Scoped Documents
          description: Total documents matched by the scoped query.
        request_duration_ms:
          anyOf:
            - type: integer
            - type: 'null'
          title: Request Duration Ms
          description: Server-side request duration in milliseconds.
        values:
          items:
            $ref: '#/components/schemas/FilterFieldValuesValue'
          type: array
          title: Values
          description: Top values ordered by count.
      type: object
      required:
        - field
        - canonical_field
        - value_type
        - supports_top_values
        - supports_exact_filter_snippet
        - total_scoped_documents
      title: FilterFieldValuesResponse
      description: Top values response for one field.
    HTTPValidationError:
      title: HTTPValidationError
      type: object
      properties:
        detail:
          type: array
          items:
            $ref: '#/components/schemas/ValidationError'
      example:
        detail:
          - loc:
              - body
              - target_company
              - domain
            msg: Field required
            type: missing
            input: null
            ctx: {}
    FilterFieldValuesValue:
      properties:
        value:
          anyOf:
            - type: string
            - type: integer
            - type: number
            - type: boolean
            - type: 'null'
          title: Value
          description: Field value; null bucket represents missing values.
        count:
          type: integer
          title: Count
          description: Document count for this value within the scoped query.
        percent_of_scope:
          type: number
          title: Percent Of Scope
          description: Share (0-1) of scoped documents matching this value.
        filter_snippet:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Filter Snippet
          description: Ready-to-merge filter clause that selects this value.
      type: object
      required:
        - count
        - percent_of_scope
      title: FilterFieldValuesValue
      description: One candidate value returned by field-values endpoints.
    ValidationError:
      title: ValidationError
      type: object
      required:
        - loc
        - msg
        - type
      properties:
        loc:
          type: array
          items:
            oneOf:
              - type: string
              - type: integer
          description: Path to the field that failed validation.
          example:
            - body
            - target_company
            - domain
        msg:
          type: string
          description: Human-readable error message.
          example: Field required
        type:
          type: string
          description: Error code (e.g. 'missing', 'value_error').
          example: missing
        input:
          description: The offending input value (any type, may be null).
          nullable: true
          example: null
        ctx:
          type: object
          description: Optional error context.
          additionalProperties: true
          example: {}

````