Utilizando os filtros no Skyone Studio

Para realizar consultas avançadas na API do Skyone Studio, utilize o parâmetro de query. O valor deste parâmetro deve ser um objeto JSON válido enviado no padrão underline query.

Estrutura Base do JSON

Abaixo, a estrutura completa que engloba ordenação, filtragem por período e paginação:

{
  "sort": {
    "startTimeUTC": -1
  },
  "filter": {
    "startTimeUTC": {
      "_period_greater_equal": "2026-01-01T00:00:00Z",
      "_period_smaller_equal": "2026-01-06T23:59:59Z"
    }
  },
  "pagination": {
    "limit": 10,
    "skip": 0
  }
}

Abaixo, compreenda melhor os itens:

Paginação (Pagination)

Controla a quantidade de dados retornados por requisição para otimizar a performance.

• limit: Define o número máximo de itens por página.

• skip: Define quantos itens devem ser pulados (offset) para acessar as próximas páginas

Exemplo:

"pagination": {
  "limit":10
  "skip": 0
}

Filtro (Filter)

O objeto filter permite refinar sua busca utilizando chaves específicas e operadores de comparação.

Operador	Descrição	Exemplo de Uso
_equal	Filtra os registros cujo valor da coluna corresponde exatamente ao valor especificado, respeitando caracteres e diferenciação entre maiúsculas e minúsculas.	"status": {"_equal": "active"}
_diff	Filtra os registros cujo valor da coluna não corresponde ao valor especificado.	"id": {"_diff": 0}
_like	Filtra os registros nos quais o valor da coluna contém o termo pesquisado, permitindo buscas parciais.	"name": {"_like": "Sky"}
_greater	Filtra os registros cujo valor da coluna é maior que o valor especificado.	"price": {"_greater": 50}
_smaller	Filtra os registros cujo valor é menor que o valor limite especificado.	"stock": {"_smaller": 10}
_greater_equal	Filtra os registros cujo valor é maior ou igual ao valor limite especificado.	"age": {"_greater_equal": 18}
_smaller_equal	Filtra os registros cujo valor é menor ou igual ao valor limite especificado.	"limit": {"_smaller_equal": 100}
_exists	Filtra os registros com base na existência do campo/coluna no documento, retornando aqueles em que o campo está presente (true) ou ausente (false), independentemente do seu valor.	"tag": {"_exists": true}
_not_exists	Filtra os registros em que o campo/coluna não existe no documento, independentemente de valor.	"deletedAt": {"_not_exists": true}
_in	Filtra os registros cujo valor da coluna está contido em uma lista (array) de valores fornecidos.	"role": {"_in": ["admin", "editor"]}

Filtros de Período (Data/Hora)

Para campos de data como startTimeUTC, utilize os prefixos de período:

• _period_greater: Data posterior a.

• _period_smaller: Data anterior a.

• _period_greater_equal: Data inicial (inclusive).

• _period_smaller_equal: Data final (inclusive).

No cenário abaixo, o filtro atua como && (and):

"startTimeUTC": {
      "_period_greater_equal": "2026-01-01T00:00:00Z",
      "_period_smaller_equal": "2026-01-06T23:59:59Z"
    }

Ordenação (Sort)

Define a direção em que os resultados são retornados com base em uma chave, sendo que:

• -1: Ordem Decrescente (padrão).

• 1: Ordem Crescente.

Exemplo:

{
  "sort":{
    "startTimeUTC":-1
  }