Marketing
Tally no seu produto e nos seus agentes de IA, por uma API
O toolkit do Tally cobre workspaces, formulários, respostas e análise dos formulários: listar e ler formulários com seus blocos, criar e atualizar, ler cada resposta com seus dados e obter visitas, conclusões, origens de tráfego e abandono por pergunta. O cliente conecta com uma API key do Tally, e seu produto ou agente de IA chama cada operação por um único endpoint do Connect.
15 dias para testar. Sem cartão de crédito.
POST https://connect.reportei.com/api/tools/tally_create_form/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"status": "BLANK",
"blocks": []
}
}Como funciona
Do cliente conectado à primeira chamada no Tally.
- 1
O cliente conecta a conta
Seu sistema abre uma sessão do Connect para o toolkit e o cliente conecta a conta do Tally. Você recebe o id da conexão.
- 2
Seu produto chama a tool
Um POST em /api/tools/{tool}/execute com o id da conexão e os argumentos. Em caso de sucesso, o Connect preserva o status e o corpo da resposta do app.
- 3
O Connect cuida do resto
Guarda a credencial criptografada, renova tokens quando a conexão usa OAuth com suporte a renovação e registra as execuções numa trilha de auditoria consultável pela API.
Para que usar
O que o seu produto faz com o Tally.
Formulários gerados pelo seu produto
Crie um formulário no Tally a partir de uma lista de blocos no workspace do cliente e atualize depois o nome, o status ou as configurações.
Respostas no seu sistema
Liste as respostas de um formulário e associe cada resposta à pergunta por questionId, para alimentar um CRM, um banco de dados ou um relatório.
Desempenho do formulário por agente
Deixe um agente ler visitas, taxa de conclusão e abandono por pergunta e sugerir qual pergunta mudar.
Tools
12 tools do Tally
- Listar workspacesGETLista os workspaces da organização com id, name, membros, convites pendentes e pastas, cada uma com id e name. Pagine com page enquanto hasMore for true.
- Listar formuláriosGETLista os formulários com id, name, workspaceId, status, numberOfSubmissions, isClosed e datas. Pagine com page enquanto hasMore for true.
- Obter formulárioGETRetorna um formulário com suas configurações e todos os blocos, cada um com uuid, type, groupUuid, groupType e payload. Atualizar formulário recebe os blocos de volta neste formato.
- Criar formulárioPOSTCria um formulário a partir dos seus blocos e retorna id, name, workspace e status. O formulário vai para o workspace padrão, a menos que workspaceId seja enviado.
- Atualizar formulárioPATCHAltera o nome, o status, as configurações ou os blocos de um formulário. Enviar blocks substitui todos eles, então leia o formulário com Obter formulário antes; name, status e settings podem ir sozinhos.
- Listar respostas do formulárioGETLista as respostas de um formulário, cada uma com id, isCompleted, submittedAt, os links de prévia e PDF e seus responses, além das perguntas do formulário, de modo que cada resposta se associa a uma pergunta por questionId. Pagine com page enquanto hasMore for true.
- Obter resposta do formulárioGETRetorna uma resposta com todos os seus responses e as perguntas do formulário.
- Obter métricas do formulárioGETRetorna os totais de um formulário no período: visitas, visualizações totais, inícios, respostas, conclusões, respondentes únicos, taxa de conclusão e as durações médias de visita e de conclusão.
- Obter visitas do formulárioGETRetorna as visitas de um formulário no período, como contagens por intervalo.
- Obter análise de respostas do formulárioGETRetorna as respostas completas e parciais de um formulário no período, como contagens por intervalo.
Chave de API
O cliente cola a chave do app numa tela do Connect, ou o seu sistema envia a chave por POST /api/customer-toolkits, sem tela.
Perguntas sobre o toolkit do Tally
Preciso implementar a API do Tally?
Não. O Connect já traz 12 tools do Tally descritas e prontas. Seu cliente conecta a conta e o seu sistema chama cada tool pelo mesmo endpoint, com o mesmo formato de requisição.
Como o cliente conecta a conta do Tally?
Pelo modo que o toolkit aceita: Chave de API. O Connect guarda a credencial criptografada e nunca a devolve ao seu sistema.
Funciona com agentes de IA?
Sim. O input de cada tool é descrito em JSON Schema, que o seu agente usa direto como definição de tool. O agente escolhe a tool e os argumentos, e o seu sistema faz a chamada ao Connect.
Meu cliente precisa ter conta no Reportei?
Não. O cliente conecta a conta numa tela do Connect, ou o seu sistema envia a credencial pela API, e ele continua usando só o seu produto.
Veja o Connect aplicado ao seu produto.
Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.
