Como ordenar 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.

$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

Caso deseje filtrar novamente por ordem crescente, você utiliza o $orderby=registerDate asc, ou seja:

• asc = crescente
• desc = decrescente

Exemplo

Neste exemplo estou buscando a listagem dos leads transferidos, no qual eles são apresentados por ordem crescente de data em que a transferência foi realizada, então por padrão eu visualizo o primeiro lead que foi transferido para outro pré-vendedor:

Podemos inserir o parâmetro para visualizar os últimos leads que foram transferidos, visualizando por ordem decrescente. Para isso inserimos o parâmetro $orderby=createdAt desc

Desta forma temos em ordem decrescente os leads transferidos de acordo com a data, ou seja, dos que foram transferidos mais recente para os mais antigos.

Também podemos ordenar por outros campos. Seguindo no mesmo exemplo acima, se quisermos ordenar por exemplo pelo usuários que receberam os leads, utilizamos o parâmetro $orderby=destinationUserId

Assim teremos os leads ordenados pelos usuários de destino dos leads transferidos

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!