API Reference

Adicione dados customizados nas entidades da plataforma.

Metadados são utilizados para criação de métricas customizadas e podem ser informados na API através de uma estrutura chave-valor:

"metadata": {
  "categoria_estabelecimento": "vestuario",
  "regional": "SP01",
} 

Requisitos

Chaves

  • Apenas string.
  • Devem possuir até 32 caracteres.
  • Permite apenas letras minúsculas não acentuadas, números, hífen (-) e sublinhado (_).
  • Exemplo: categoria_produto

Valores

  • Apenas string.
  • Devem possuir até 64 caracteres.
  • Permite qualquer letra não acentuada, números, hífen (-) e sublinhado (_), diferenciando maiúsculas e minúsculas nas consolidações de métricas.
  • Exemplo: P01-Xyz_

Limitações

Consulte o artigo sobre limites e parâmetros para verificar a quantidade máxima permitida de metadados por entidade.