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âmetroTipoObrigatórioDescrição
survey_idstringSimId of the survey, from List surveys.
namestringNãoOnly the collectors whose name matches this text.
start_datestringNãoOnly collectors created after this moment, a UTC date and time as YYYY-MM-DDTHH:MM:SS, without offset.
end_datestringNãoOnly collectors created before this moment, a UTC date and time as YYYY-MM-DDTHH:MM:SS, without offset.
includestringNãoExtra fields, separated by commas: type, status, response_count, date_created, date_modified and url.
sort_bystringNãoField the collectors are sorted by.Valores: id, date_modified, type, status, name
sort_orderstringNãoAscending or descending order.Valores: ASC, DESC
pageintegerNãoPage of results, starting at 1.
per_pageintegerNãoResults 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

Ver as 11 tools

Toolkits da mesma categoria

Ver os 100 toolkits

Veja o Connect aplicado ao seu produto.

Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.