Documentação Técnica

Utilizando Datas de Referência

Ao realizar qualquer consulta, é possível também passar uma data de referência como parâmetro, utilizando a data no formato yyyy-MM-dd (por exemplo, 2019-06-05). Essa data é usada como referência para as consultas realizadas na API, fazendo com que seja retornada uma fotografia dos dados na data em questão. Essa funcionalidade é útil para a realização de back-tests em cima dos dados sem a necessidade de qualquer solicitação especial à equipe da BigData Corp.

O exemplo abaixo mostra como realizar uma chamada com data de referência ao dataset de 'Endereços' de pessoas:

Body:
{
    "Datasets": "addresses",
    "q": "doc{xxxxxxxxxxx},referencedate{2018-09-03},dateformat{yyyy-MM-dd}"
}

Nota: Se for enviada uma data inválida, será considerada a data atual como referência, o que equivale a uma consulta sem data de referência. Nas consultas à API On-demand não é possível passar uma data de referência específica.