- O que é o filtro Pivot?
- Primeira consulta e armazenamento
- Como funciona a atualização incremental
- Exemplo prático no Postman
O que é o filtro Pivot?
O filtro pivot da API Analytics foi criado para facilitar o processo de popular uma base de dados, data warehouse ou data lake de forma incremental. Ou seja, com ele conseguimos buscar apenas as diferenças em relação a uma determinada data.
Primeira consulta e armazenamento
Para entender o funcionamento, imagine o seguinte cenário: você está consultando informações para salvar em um local da sua organização e possui 10.000 registros de cadastro de unidades.
Inicialmente, você realizará uma primeira consulta completa, sem filtros, para o recurso de unidades:
Acesse a documentação da rota aqui
Neste processo, você irá percorrer todas as páginas (ex: 10 páginas de 1.000 registros cada), salvando esses dados em seu banco local.
→ Importante: Você deve salvar a data e hora exata em que realizou esta primeira consulta. Ela será sua referência futura.
Como funciona a atualização incremental
Quando precisar atualizar suas informações, não será necessário consultar todas as unidades novamente. Com a utilização do filtro pivot, a API retornará apenas o que houve de diferença após a data da sua consulta inicial.
Essa diferença considera basicamente três fatores:
- Novos registros cadastrados;
- Registros que foram atualizados;
- Registros removidos (que possuem data preenchida em deletedAt).
→ Dica: Utilize o parâmetro pivot[gte]. Dessa forma, você solicita tudo que teve diferença a partir daquela data, aplicando uma atualização incremental eficiente.
Exemplo prático no Postman
Supondo que a sua primeira requisição tenha sido feita em 05/05/2022 às 10:30:00 (Timezone America/Sao_paulo), sua requisição ficará semelhante à imagem abaixo:
Note no exemplo acima que o primeiro item retornado é uma unidade cadastrada originalmente em 2017, mas que aparece nesta lista porque teve uma atualização no dia 09/05/2022 (data posterior ao nosso pivot).
Perguntas Frequentes (FAQ)
1. O filtro pivot retorna apenas dados novos?
Não. O filtro retorna qualquer registro que tenha sofrido alteração a partir da data informada. Isso inclui novos cadastros, edições em cadastros antigos e exclusões (marcadas com deletedAt).
2. Qual parâmetro devo usar para a data?
Recomendamos o uso do parâmetro pivot[gte] (greater than or equal / maior ou igual) para garantir que você pegue todas as mudanças a partir do momento da última sincronização.
❓Tem dúvidas? Entre em contato com nosso time de suporte.