Listar coletores no SurveyMonkey, por uma API
Lista 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.
- Identificador
- surveymonkey_list_collectors
A chamada
POST https://connect.reportei.com/api/tools/surveymonkey_list_collectors/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>"
}
}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. |
| name | string | Não | Only the collectors whose name matches this text. |
| start_date | string | Não | Only collectors created after this moment, a UTC date and time as YYYY-MM-DDTHH:MM:SS, without offset. |
| end_date | string | Não | Only collectors created before this moment, a UTC date and time as YYYY-MM-DDTHH:MM:SS, without offset. |
| include | string | Não | Extra fields, separated by commas: type, status, response_count, date_created, date_modified and url. |
| sort_by | string | Não | Field the collectors are sorted by.Valores: id, date_modified, type, status, name |
| sort_order | string | Não | Ascending or descending order.Valores: ASC, DESC |
| page | integer | Não | Page of results, starting at 1. |
| per_page | integer | Não | Results per page, up to 1000. |
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_list_collectors. 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.
- 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.
Veja o Connect aplicado ao seu produto.
Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.
