Listar pesquisas disparadas

Query Params
string

Campo para pesquisa

Formato [campo:valor]

Campos permitidos:

  • id (ID do disparo da pesquisa)
  • survey_id (ID da pesquisa)
  • survey_response_status_id (ID do status do disparo da pesquisa)
  • deal_id (ID da oportunidade do CRM de Vendas)
  • sent_at (Data/hora do disparo da pesquisa)
  • expires_at (Data/hora da expiração do disparo da pesquisa)
  • talk.customer_id (ID do cliente)
  • talk.customer.external_id (ID externo do cliente)
  • talk.customer.document_number (Número do documento do cliente)
Ex: survey_id:1

string
enum
Defaults to or

Tipo de condição aplicada quando a requisição possuir mais de 1 critério de busca.

  • and: Todas os critérios precisam ser atendidos
  • or: Qualquer critério precisa ser atendido

Allowed:
string
Defaults to id

Nome do campo pelo qual a consulta será ordenada

string
enum
Defaults to asc

Tipo de ordenação aplicada na consulta.

  • asc: Ordenação em ordem ascendente ou crescente
  • desc: Ordenação em ordem descendente ou decrescente

Allowed:
string

Entidades que serão relacionadas ao retorno da requisição.
Para adicionar mais de uma entidade, utilize o separador ";"

Entidades permitidas:

  • survey: Dados da pesquisa
  • survey.channel: Dados do canal de atendimento
  • survey.surveyQuestions: Dados das perguntas enviadas na pesquisa
  • surveyResponseFinalScore: Dados da nota final da pesquisa
  • surveyResponseQuestions: Dados das respostas enviadas pelo cliente
  • surveyResponseQuestions.surveyQuestion: Dados das perguntas respondidas pelo pesquisa
  • surveyResponseQuestions.surveyQuestion.surveyMethodology: Dados da metodologia utilizada na pergunta
  • talk: Dados do atendimento gerado no envio da pesquisa
  • talk.customer: Dados do cliente pesquisado
  • talk.talkHistoryFirst: Dados da mensagem enviada para o cliente

string

Colunas que deseja visualizar no retorno da consulta. Para mais de uma coluna, utilize o separador ";"

string
Defaults to 20

Quantidade de registros retornados por página

Headers
string
required
Defaults to application/json
string
required
Defaults to application/json
Responses

Language
Credentials
Header
URL
Request
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json