Criar pesquisa no SurveyMonkey, por uma API

Cria 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.

Identificador
surveymonkey_create_survey

A chamada

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>"
  }
}

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
titlestringNãoTitle of the survey. New Survey when it is left out.
nicknamestringNãoInternal name of the survey, shown only to the account.
languagestringNãoISO 639-1 code of the survey language, like en, es or pt. en by default.
folder_idstringNãoPuts the survey in this folder: an id from List survey folders.
footerbooleanNãofalse hides the SurveyMonkey footer.
buttons_textobjectNãoTexts of the survey buttons. An empty exit_button removes the exit button.
custom_variablesobjectNãoCustom variables of the survey, the extra values a survey link carries, keyed by variable name.
from_survey_idstringNãoCopies the pages and questions of this survey: an id from List surveys.
pagesarrayNãoPages to create with the survey, each with its questions. Leave it out to create an empty survey or a copy.

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_survey. 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.