Listar pesquisas no SurveyMonkey, por uma API

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

Identificador
surveymonkey_list_surveys

A chamada

POST https://connect.reportei.com/api/tools/surveymonkey_list_surveys/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ãoOnly the surveys whose title matches this text.
folder_idstringNãoOnly the surveys of this folder: an id from List survey folders.
start_modified_atstringNãoOnly surveys changed after this moment, a UTC date and time as YYYY-MM-DDTHH:MM:SS, without offset.
end_modified_atstringNãoOnly surveys changed before this moment, a UTC date and time as YYYY-MM-DDTHH:MM:SS, without offset.
includestringNãoExtra fields or filters, separated by commas: response_count, date_created, date_modified, language, question_count, analyze_url, preview and collect_stats add fields; owned, shared_with and shared_by filter by ownership.
sort_bystringNãoField the surveys are sorted by.Valores: title, date_modified, num_responses
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_surveys. 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.