Tags são rótulos ou identificadores customizados utilizados para categorizar, organizar ou adicionar informações extras a um determinado conjunto de dados. Em sistemas e APIs, elas permitem anexar metadados, como palavras-chave ou atributos específicos, facilitando a identificação, filtragem ou análise de informações. O que proporciona flexibilidade e personalização na gestão e consulta de dados.

Todas as APIs de enriquecimento da BigData Corp. permitem o envio de tags nas chamadas. Essas marcações possibilitam a inserção de informações customizadas, através de pares de chave e valor, que serão registradas juntamente com os dados retornados da requisição.

As tags de chamada podem ser utilizadas como filtros nas chamadas à API de Eventos , possibilitando uma maneira simples de obter as chamadas relacionadas a um determinado processo.

Exemplo de uso:

{
  "Datasets": "basic_data",
  "q": "doc{xxxxxxxxxxx}",
  "Tags": {
    "my_key": "my_value",
    "environment": "production"
  }
}

{
  "Datasets": "registration_data,kyc,occupation_data",
  "q": "doc{xxxxxxxxxxx}",
  "Tags": {
    "host": "HOST_ID",
    "process": "ONBOARDING"
  }
}

Regras de Uso

Para que a chamada possa ser realizada com sucesso, todas as tags inseridas devem atender às seguintes regras:

1. No máximo 10 tags podem ser enviadas por requisição.
2. Chaves e valores das tags devem ter de 1 a 255 caracteres.
3. Chaves devem conter apenas letras de A a Z (sem acentuação) ou o caractere '_' (underline).
4. Valores podem possuir quaisquer letras, números, espaços ou os seguintes caracteres especiais: _*-+,.:!@#&/ .