Filtros 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.

$skip

Atualmente temos uma limitação de 500 requisições por página. Sendo assim, para trazer a próxima listagem, é necessário utilizar, por exemplo:

$skip=500 <- Aqui insere a quantidade de requisições que deseja pular

 $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

$orderby

 Os dados vindos via API retornam em ordem crescente, ou seja, primeiro chegam os dados mais antigos e depois os mais recentes. Para alterar essa ordem e trazer os dados recentes primeiro, podemos utilizar deste "$orderby", utilizando como exemplo o endpoint /Leads:

$orderby=registerDate desc <- O "registerDate" será o parâmetro utilizado para ordenação neste exemplo

$select

Para trazer apenas uma informação dentre os dados de um endpoint, é possível utilizar do "$select", assim irá retornar apenas a informação desejada. Por exemplo, buscar ID dentro de /Leads :

$select=id <- Aqui insere a informação que deseja trazer sem aspas

Também é possível trazer uma sequência de dados em um mesmo endpoint, usando o mesmo exemplo, mas trazendo nome do Lead, ID e valor de origem:

$select=lead, id, source/value <- Aqui insere as informações separando por vírgula e espaço

Queremos sua opinião! Por favor, compartilhe seu feedback sobre nosso artigo na Central de Ajuda para que possamos atender melhor às suas necessidades. Agradecemos por nos ajudar a melhorar!