Criar coletor no SurveyMonkey, por uma API
Cria 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.
- Identificador
- surveymonkey_create_collector
A chamada
POST https://connect.reportei.com/api/tools/surveymonkey_create_collector/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"survey_id": "<survey_id>",
"type": "weblink",
"name": "<name>"
}
}Seu sistema envia o id da conexão do cliente e os argumentos da tool. Os headers são os mesmos de toda a API do Connect: o token do seu produto e o token do cliente.
Parâmetros
As descrições dos parâmetros seguem a documentação oficial do app, em inglês.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| survey_id | string | Sim | Id of the survey, from List surveys. |
| type | string | Sim | weblink gives a link to share, returned in url. email needs a paid plan, and its invitations are sent from SurveyMonkey.Valores: weblink, email |
| name | string | Sim | Name of the collector, shown only to the account. |
| thank_you_page | object | Não | Custom thank-you page shown after a response. |
| redirect_type | string | Não | End of the survey: url goes to redirect_url (or the standard thank-you page when it is empty), close closes the window and loop starts over, only for a weblink with allow_multiple_responses.Valores: url, close, loop |
| redirect_url | string | Não | URL the respondent goes to after finishing. |
| close_date | string | Não | When the collector stops accepting responses, as an ISO 8601 date and time. |
| closed_page_message | string | Não | Message shown when the collector is closed. |
| response_limit | integer | Não | Closes the collector after this many responses. |
| allow_multiple_responses | boolean | Não | Lets the same browser answer more than once. Not for email collectors. |
| anonymous_type | string | Não | Turns off IP tracking; in an email collector, fully_anonymous also drops the email and name of the respondent.Valores: not_anonymous, partially_anonymous, fully_anonymous |
| edit_response_type | string | Não | When a respondent can still change the answers.Valores: until_complete, never, always |
| display_survey_results | boolean | Não | Shows the current results to the respondent at the end. |
| password | string | Não | Password the respondent must type to open the survey. |
| disqualification_message | string | Não | Message for a respondent who is disqualified by the survey logic. |
| disqualification_url | string | Não | URL a disqualified respondent goes to. |
Conexões possíveis
O seu cliente conecta a conta do SurveyMonkey uma vez, por um dos modos abaixo. A mesma conexão serve para todas as tools do toolkit.
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.
A resposta
Em caso de sucesso, o Connect preserva o status e o corpo da resposta do app. Erros HTTP retornados pelo app usam o envelope {error, api_error}; falhas de autenticação ou validação podem ocorrer antes da execução. O header X-Toolkit-Execution-Id identifica a execução registrada, consultável em GET /api/tools/executions/{uuid}.
Pronta para agentes de IA
O input desta tool é um JSON Schema, disponível em GET /api/tools/surveymonkey_create_collector. Ele vira a definição de tool do seu agente sem conversão.
Outras 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.
- 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.
Veja o Connect aplicado ao seu produto.
Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.
