As consultas da Plataforma de Dados seguem uma estrutura padronizada, utilizada em todas as APIs da BigDataCorp.

Nesta seção, você aprenderá:

Esses conceitos formam a base para a construção de consultas e serão fundamentais para compreender os próximos tópicos da documentação, incluindo parâmetros de consulta, chaves de identificação, personalização de retorno e recursos adicionais.

1️⃣ Estrutura básica da requisição

As APIs da Plataforma de Dados utilizam o método POST, e recebem, no corpo da requisição, três parâmetros principais:

• q – chaves de busca (obrigatório)
• Datasets – datasets desejados no retorno (obrigatório)
• Limit – limite máximo de entidades retornadas (opcional)

{
  "q": "doc{12345678900}",
  "Datasets": "basic_data"
}

{
  "q": "name{josé da silva}, birthdate{01-01-1970}, dateformat{dd-mm-yyyy}",
  "Datasets": "basic_data",
  "Limit": 5
}