Como filtrar os resultados das minhas requisições via API?

A API do Exact Spotter disponibiliza um serviço para acessar e manipular dados sob o protocolo HTTP no padrão OData. Este protocolo permite que você realize filtros e ordenações utilizando "comandos" como filter, orderby, select, top, count, etc.

Todos os comandos podem ser localizados pelo tutorial básico do OData diretamente neste link, porém visando trazer exemplos próximos ao Spotter, disponibilizamos este artigo.

 $filter 

Para localizar o resultado esperado, precisamos primeiramente entender o parâmetro desejado. Por exemplo, caso a busca seja pelo ID do Lead, dentro do endpoint de listagem de Leads, a busca é feita da seguinte forma:

$filter=id eq 1234 <- Aqui insere o ID do Lead sem aspas

Já a busca pelo endpoint /Meetings, por exemplo, o ID do Lead fica dentro da chave de Lead, sendo assim, a busca é feita da seguinte forma:

$filter=lead/id eq 1234 <- Aqui insere o ID do Lead sem aspas

Também é possível realizar busca por nome ou termo específico. Por exemplo, buscar Leads dentro do endpoint /Leads que estejam na etapa "Agendados":

$filter=stage eq 'Agendados' <- Aqui insere o nome da etapa entre aspas simples

Exemplo

No exemplo abaixo, estamos realizando a listagem de transferência de leads, ou seja, os leads que foram transferidos de um pré-vendedor para outro:

Podemos visualizar no print acima que apresenta dados de todos os leads que já foram transferidos. Suponhamos que você deseja visualizar os dados apenas de um lead específico. Para isso, aplicamos o parâmetro $filter=leadId eq 1234 (substitua o 1234 pelo número do id do usuário) para filtrar e visualizar apenas os dados deste lead específico:

Outro exemplo: podemos filtrar os dados de todos os leads que foram transferidos para um pré-vendedor específico, filtrando pelo "destinationUserId" com o parâmetro $filter=destinationUserdId eq 1234 (substitua o 1234 pelo número do id do usuário):

Com isso estaremos visualizando os dados filtrados pelo usuário específico de destino dos leads

Esperamos que esse artigo seja útil em seu dia a dia!

Não esqueça de avaliar aqui para que a gente possa melhorar cada vez mais nossos materiais. 

Até a próxima!