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

# Simular o ranking da lista

> Aplica os critérios em memória e devolve o top-N na ordem resultante. Nada é persistido.



## OpenAPI

````yaml https://api.nuvia.ai/api/docs/user-json post /v1/tables/{id}/ranking-preview
openapi: 3.0.0
info:
  title: Nuvia API - Empresa
  description: Documentação da API para empresas
  version: '1.0'
  contact: {}
servers:
  - url: https://api.nuvia.ai
security: []
tags:
  - name: messages
    x-group: Mensagens
  - name: contacts
    x-group: Contatos
  - name: campaigns
    x-group: Campanhas
  - name: tables
    x-group: Tabelas e Listas
  - name: agents
    x-group: Agentes
  - name: conversations
    x-group: Conversas
  - name: inboxes
    x-group: Caixas de Entrada
  - name: knowledge
    x-group: Base de Conhecimento
  - name: Webhooks
    x-group: Webhooks
  - name: campaign-enrollments
    x-group: Inscrições em Campanha
  - name: custom-fields
    x-group: Campos Customizados
  - name: resources
    x-group: Arquivos e Anexos
paths:
  /v1/tables/{id}/ranking-preview:
    post:
      tags:
        - tables
      summary: Simular o ranking da lista
      description: >-
        Aplica os critérios em memória e devolve o top-N na ordem resultante.
        Nada é persistido.
      operationId: TableController_previewRanking
      parameters:
        - name: x-company-id
          in: header
          description: >-
            Identificador da empresa-alvo. Obrigatório apenas para API Keys
            globais (type=global). Ignorado para API Keys de empresa e usuários
            humanos.
          required: false
          schema:
            type: string
        - name: id
          required: true
          in: path
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PreviewTableRankingBodyDto'
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                type: object
      security:
        - JWT-auth: []
components:
  schemas:
    PreviewTableRankingBodyDto:
      type: object
      properties:
        ranking_config:
          type: array
          minItems: 1
          items:
            type: object
            properties:
              column:
                type: string
                description: '`key` da coluna da tabela avaliada.'
              rule:
                type: string
                enum:
                  - positive_first
                  - value_eq
                  - asc
                  - desc
                description: >-
                  Como a coluna pontua: `positive_first` (número maior que zero
                  primeiro), `value_eq` (igual a `value` primeiro, sem
                  diferenciar maiúsculas), `asc` (menor valor primeiro) ou
                  `desc` (maior valor primeiro).
              value:
                description: Valor comparado. Obrigatório quando `rule` é `value_eq`.
                type: string
            required:
              - column
              - rule
          description: >-
            Critérios de ranking, em ordem de prioridade. Pelo menos um; toda
            coluna precisa existir na tabela.
        limit:
          type: integer
          description: Quantas linhas devolver. Padrão 5, entre 1 e 20.
          minimum: -9007199254740991
          maximum: 9007199254740991
      required:
        - ranking_config
  securitySchemes:
    JWT-auth:
      scheme: bearer
      bearerFormat: JWT
      type: http
      description: Token JWT de autenticação

````

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