Quando utilizar
Use interpolação quando precisar:- Inserir valores de parâmetros em URLs ou paths de API
- Adicionar datas dinâmicas às requisições (hoje, ontem, semana passada)
- Referenciar datas dos datapoints de extração
- Gerar nomes de arquivos com timestamps
- Construir query strings parametrizadas
Variáveis Simples
Substitua placeholders por valores dos parâmetros da sua integração. O nome da variável deve corresponder exatamente.Utilizando datapoint com variável simples
Para interpolar um valor de datapoint, adicione um query param com o nome do campo do datapoint. O nome do param fica disponível como variável.Interpolação DateTime
Insira datas atuais, calcule datas relativas e formate a saída para requisitos de APIs. A interpolação DateTime suporta três prefixos:
Após o prefixo, encadeie operações com pontos. As operações de data são aplicadas na ordem em que foram escritas e podem ser repetidas:
Uma operação com erro de digitação ou não suportada falha a requisição com um erro claro, em vez de ser ignorada silenciosamente.
Padrões de Formato
Use.format(pattern) para controlar a saída. Os padrões seguem os tokens de formato do dayjs.
Conversão de Timezone
Use.timezone(tz) para avaliar a data em um timezone específico. O timezone padrão é America/Sao_Paulo. tz é um alias de timezone.
Idioma (Locale)
Use.locale(nome) para gerar nomes formatados (meses, dias da semana) em outro idioma. O padrão é inglês; pt-br está disponível. Um locale que não está disponível cai de volta para o inglês.
format, timezone e locale são configurações de contexto: podem aparecer em qualquer posição da cadeia e a posição não altera o resultado.
Aritmética de Datas
Adicione ou subtraia tempo usando.add(quantidade.unidade) e .subtract(quantidade.unidade) — a quantidade e a unidade são separadas por ponto. plus é um alias de add; remove e minus são aliases de subtract.
Unidades disponíveis: day, week, month, quarter, year, hour, minute, second (formas no plural também funcionam)
Limites de Período
Use.startOf(unidade) e .endOf(unidade) para ir ao limite de um período. endOf resolve o tamanho real de cada mês, incluindo anos bissextos.
Unidades disponíveis: day, week, isoWeek, month, quarter, year, hour, minute, second
week começa no domingo; use isoWeek para semanas que começam na segunda-feira:
Definindo Unidades
Use.set(unidade.valor) para fixar uma unidade em um valor exato, mantendo todo o resto.
Ordem das Operações
As operações de data executam da esquerda para a direita, então a cadeia lê exatamente como o que acontece — e a mesma operação pode aparecer mais de uma vez:Usando Campos de Dados
Referencie datas dos seus datapoints de extração com a funçãodate(). Passe o caminho do campo como argumento.
Exemplo Completo
Uma extração mensal que sempre cobre o mês anterior completo, qualquer que seja o tamanho do mês:Quando um parâmetro está ausente
Se um{{ parametro }} referenciado em uma URL, header ou body não tiver valor em tempo de execução, a requisição não é enviada: ela falha com um erro claro de interpolação informando o parâmetro ausente. Uma string vazia conta como ausente: enviá-la produziria uma requisição malformada (ex.: /items//details) que a API de destino rotearia incorretamente em vez de rejeitar.
Os nomes dos parâmetros diferenciam maiúsculas de minúsculas e devem corresponder exatamente ao campo dos dados.