Marketing
SurveyMonkey no seu produto e nos seus agentes de IA, por uma API
O toolkit do SurveyMonkey cobre pesquisas e pastas, coletores (links web e convites por email), respostas individuais e resumos por pergunta. Seu cliente conecta o SurveyMonkey uma vez por OAuth, e seu produto ou agente de IA chama cada operação pelo Connect, que guarda e renova as credenciais e registra cada execução.
15 dias para testar. Sem cartão de crédito.
POST https://connect.reportei.com/api/tools/surveymonkey_create_survey/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"title": "<title>"
}
}Como funciona
Do cliente conectado à primeira chamada no SurveyMonkey.
- 1
O cliente conecta a conta
Seu sistema abre uma sessão do Connect para o toolkit e o cliente conecta a conta do SurveyMonkey. 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 SurveyMonkey.
Lance uma pesquisa pelo seu app
Crie uma pesquisa com suas páginas e perguntas, adicione um coletor weblink e compartilhe a url com seus usuários.
Leve respostas para o seu produto
Liste as respostas de uma pesquisa com simple true e envie as respostas ao seu CRM ou analytics assim que chegarem.
Agente resume os resultados
Um agente de IA lê Listar resumos da pesquisa e Obter pesquisa para explicar quantas pessoas escolheram cada resposta, usando os ids das perguntas.
Tools
11 tools do SurveyMonkey
- Listar pesquisasGETLista as pesquisas que a conta possui ou que foram compartilhadas com ela, com id, título e nickname; include adiciona contagens, datas e links. Pagine com page enquanto a resposta tiver links.next.
- Listar pastas de pesquisasGETLista as pastas de pesquisas da conta com id, título e número de pesquisas. Pagine com page enquanto a resposta tiver links.next.
- Obter pesquisaGETRetorna a pesquisa inteira: configurações, os links de edição, prévia, coleta e análise, e cada página com suas perguntas e opções de resposta, todos com seus ids. As ferramentas de respostas e Listar resumos da pesquisa se referem a esses ids.
- Criar pesquisaPOSTCria uma pesquisa: vazia, copiada de outra pesquisa com from_survey_id, ou com suas páginas e perguntas em pages. Retorna o id da pesquisa e seus links de edição, prévia e coleta. Ela ainda precisa de um coletor para receber respostas.
- Atualizar pesquisaPATCHAltera o título, nickname, idioma, textos dos botões, variáveis customizadas, rodapé ou pasta de uma pesquisa. Páginas e perguntas permanecem como estão.
- Listar coletoresGETLista os coletores de uma pesquisa, as formas como ela recebe respostas, como um link web ou um convite por email, com id e nome; include adiciona type, status, url e response_count. Pagine com page enquanto a resposta tiver links.next.
- Criar coletorPOSTCria um coletor para uma pesquisa. Um coletor weblink retorna o link para compartilhar em url, e é o único tipo que o plano gratuito pode criar. Um coletor email só prepara o convite: destinatários e envio ficam no SurveyMonkey.
- Atualizar coletorPATCHAltera um coletor: fecha ou reabre com status, ou muda seu nome, data de encerramento, limite de respostas, mensagens e redirecionamento.
- Listar respostasGETLista as respostas de uma pesquisa com todas as respostas dadas, como ids de pergunta, opção e linha, mais os textos quando simple é true. No plano gratuito só as primeiras 25 respostas de cada pesquisa voltam, e pedir mais retorna o erro 1005. Pagine com page enquanto a resposta tiver links.next.
- Obter respostaGETRetorna uma resposta com todas as respostas dadas, seu status, horários, coletor e os dados do respondente que o coletor guarda.
OAuth com o app do seu produto
Você cadastra o app OAuth do seu produto uma vez, em POST /api/merchants/credentials/surveymonkey, e o cliente autoriza a conta numa tela de consentimento. O Connect renova o token quando ele está para vencer.
Perguntas sobre o toolkit do SurveyMonkey
Preciso implementar a API do SurveyMonkey?
Não. O Connect já traz 11 tools do SurveyMonkey 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 SurveyMonkey?
Pelo modo que o toolkit aceita: OAuth com o app do seu produto. 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.
