Filtros em consultas

O filtro possibilita selecionar um subconjunto específico de resultados de uma requisição.

Caso o endpoint que você está usando possibilite filtros, você poderá acrescentar uma "query string" à URL para especificar os parâmetros de filtragem.

Exemplo: Para encontrar um usuário de sua conta pelo nome "alex", você deve usar uma string de consulta "name=alex", e sua URL de requisição ficará como a do trecho abaixo:

GET https://api.pipe.run/v1/users?name=alex

Como este é um filtro é inclusivo e parcial, todos os nomes de usuários que contêm a sequência "alex", como "Alexia Jones", "Alexandre Santiago" e "Salex Silva" são retornados como resultados.

Você pode utilizar quantos filtros forem necessários para realizar sua consulta, mas evite URLs muito longas acima de 2000 caracteres, pois nem todos os clientes suportam URLs muito extensas.
Para utilizar mais de um filtro, adicione um & entre eles name=alex&[email protected].

GET https://api.pipe.run/v1/users?name=alex&[email protected]

Os endpoints que possuírem filtros disponíveis, contém uma sessão de referência documentada em sua descrição e complementos, incluindo alguns exemplos.

Filtros por data

Os filtros por data funcionam com um intervalo especificado com o nome da coluna e os prefixos _start e _end.

Valores aceitos pelos campos filtrados podem ser informados no formato Y-m-d (ex: 2024-12-31) ou no formato Y-m-d H:i:s (ex: "2024-12-31 23:59:59"). Caso informada a data no formato Y-m-d, o filtro considera o o inicio do dia no horário 00:00:00. Dica: Lembre-se que os parâmetros de string vazia e dois pontos são encodados em uma URL com os caracteres %20 e %3A respectivamente.

Logo abaixo temos exemplos simples usando a busca de oportunidades por data de abertura. No primeiro exemplo usamos apenas a data inicial do período para filtro e no segundo exemplo temos um intervalo de datas entre 01 de janeiro e 31 de janeiro com horários específicos.

// GET https://api.pipe.run/v1/deals?created_at_start=2025-01-01%2012%3A30%3A14

const options = {
    method: "GET",
    headers: {
        Accept: "application/json",
        Token: "YOUR_TOKEN_HERE"
    }
}
const baseUrl = "https://api.pipe.run/v1"
const params = new URLSearchParams({
    show: 20,
    page: 1,
    created_at_start: "2025-01-01 12:30:14"
})

fetch(`${baseUrl}/deals?${params.toString()}`, options)
    .then(result => result.json())
    .then(response => console.log(response))
    .catch(exception => console.error(exception));

// GET https://api.pipe.run/v1/deals?show=100&page=2&created_at_start=2025-01-01%2012%3A30%3A14&created_at_end=2025-01-31%2022%3A12%3A18

const options = {
    method: "GET",
    headers: {
        Accept: "application/json",
        Token: "YOUR_TOKEN_HERE"
    }
}
const baseUrl = "https://api.pipe.run/v1"
const params = new URLSearchParams({
    show: 100,
    page: 2,
    created_at_start: "2025-01-01 12:30:14",
    created_at_end: "2025-01-31 22:12:18"
})

fetch(`${baseUrl}/deals?${params.toString()}`, options)
    .then(result => result.json())
    .then(response => console.log(response))
    .catch(exception => console.error(exception));