Perguntas comuns de API

Sobre perguntas de API comuns

A Qualtrics tem vários produtos diferentes que permitem que nossos clientes coletem dados acionáveis em tempo real. Alguns desses produtos incluem Plataforma de pesquisa, Website / App Feedback, XM Directory e Qualtrics 360. Depois de adquirir o recurso da API da Qualtrics, você poderá usar a API para qualquer produto que faça parte da sua licença.

• Documentação de API para a Plataforma de pesquisa e o Diretório XM.
• Documentação de API para Website / App Feedback.

Plataforma de pesquisa

Tenho todos os parâmetros corretos, mas continuo recebendo uma mensagem de erro que diz “Solicitação inválida. Parâmetro Solicitação ausente ou inválido.” Por que isso está acontecendo?

Exemplo:

curl -X POST \  https://yourdatacenterid.qualtrics.com/API/v3/responseexports \   
 -H 'content-type: application/json' \  -H 'x-api-token: 12345678901234567890' \   
 -d '{"levantyId":"SV_1234567890","Format":"json"}'

Os parâmetros da API da Qualtrics diferenciam maiúsculas de minúsculas. Neste exemplo, seu parâmetro é chamado “Formato” quando deve ser “formato”. Atualize isso e você poderá executar com êxito sua solicitação de API.

Gostaria de baixar meus dados brutos para abrir no Excel. Que solicitação de API devo usar?

Use a solicitação Criar exportação de resposta para iniciar o processo de exportação e especificar que o formato do arquivo de exportação de resposta deve ser CSV. Em seguida, você precisará utilizar a solicitação Obter andamento da exportação de resposta para verificar se o arquivo está pronto, seguido pela solicitação Obter arquivo de exportação de resposta para baixar seu arquivo CSV.

Ao usar Criar contatos Importar, quais são os diferentes métodos de postar ou enviar minha lista de contatos para a Qualtrics?

Existem duas opções para carregar sua lista de contatos:

1. Você pode definir o Content-Type para dados de várias partes/formulários e carregar seus contatos como um arquivo JSON.
2. Você pode definir o Content-Type como application/json e publicar os contatos como um array JSON no corpo da solicitação.

Estou limitado ao número de solicitações que posso fazer para minha organização? E quantas solicitações simultâneas de API posso fazer de uma só vez?

Consulte esta página da API para obter mais informações sobre limites.

Estou usando a solicitação Importar pesquisa e salvei minha pesquisa como um arquivo TXT. A solicitação é bem-sucedida, mas minhas perguntas não aparecem na minha pesquisa recém-importada. Por que isso está acontecendo?

Você precisará verificar se está seguindo o formato necessário para importar pesquisas para a Qualtrics. Para saber mais sobre a formatação TXT, consulte Preparando um arquivo TXT em formato simples e Preparando um arquivo TXT em formato avançado. Assim que seu arquivo estiver formatado corretamente, a solicitação será executada com êxito.

Estou usando a solicitação Create Response Export (Criar resposta de exportação) com os parâmetros startDate e endDate. No entanto, quando vejo os dados baixados, não estou vendo o intervalo de datas previsto de respostas.

A chave para utilizar os parâmetros startDate e endDate está entendendo que valor de data está sendo utilizado para avaliar a condição que você está criando (ou seja, que datas estão sendo analisadas para avaliar a startDate que você define e a data final que você define). Esses dois parâmetros estão usando a data em que o participante iniciou a pesquisa. Esse valor, chamado de Data de início, pode ser encontrado em sua guia Dados & Análise e dados baixados. Assim, se você definir seu parâmetro startDate como 2017-01-01 e seu parâmetro endDate como 2017-01-02, baixará as respostas que foram registradas (enviadas ou incompletas) para participantes da pesquisa que iniciaram sua pesquisa dentro do intervalo de datas de 1 de janeiro de 2017 a 2 de janeiro de 2017.

Qdica: uma resposta da pesquisa não é registrada até o participante clicar no botão Enviar dentro de uma pesquisa ou quando respostas incompletas à pesquisa O período de tempo foi cumprido.

Feedback via site/app

Para perguntas sobre Website/App Feedback, entre em contato com nossa equipe de suporte de Website/App Feedback.

Diretório XM

Posso usar a API da plataforma de pesquisa agora que também estou usando o XM Directory?

Sim, com certeza. O XM Directory tem algumas solicitações de API que substituirão as solicitações feitas por meio da API da Plataforma de pesquisa, mas, na maioria das vezes, você ainda pode usar todas as solicitações da API da Plataforma de pesquisa. As solicitações de contatos da Plataforma de pesquisa são as únicas que podem ser alteradas. Na documentação da v3, as solicitações de API que não são suportadas pelos usuários do XM Directory (e vice-versa) terão um aviso.

Que funcionalidade adicional a API do XM Directory oferece para a qual eu não tenho acesso apenas com a API da plataforma de pesquisa?

A API do XM Directory fornece algumas solicitações exclusivas específicas do XM Directory. Você pode usar getBouncedContacts (API v2.4) para encontrar todos os contatos em seu diretório (ou em uma lista de destinatários específica) que já tiveram um bounce de e-mail. A solicitação de contatos do diretório de lista pode ser usada para exportar um subconjunto de todo o seu diretório. A solicitação getIncentiveRecipients permite que você baixe uma lista de todos os contatos em seu diretório que receberam um incentivo específico, como recompensa de pontos ou entrada de sorteios. Essas e outras solicitações estão disponíveis com a API do XM Directory.

Qual é a diferença entre o ID de contato e o ID do destinatário?

Cada solicitação de API do XM Directory normalmente solicita o ID de contato do contato. Este ID começa com “CID_” e é seguido por uma cadeia alfanumérica única. O ID do contato é o ID exclusivo do contato em seu diretório. Algumas solicitações de API solicitam o ID do destinatário do contato. Este ID começa com “CGC_” e é seguido por uma cadeia alfanumérica única. A ID do destinatário é a ID exclusiva do contato em uma lista de destinatários.

Para entender a diferença entre o ID do contato e o ID do destinatário, é importante lembrar que cada contato só deve existir uma vez em seu diretório. Assim, um único contato pode ser encontrado em seu diretório uma vez, mas também pode ser um membro de várias listas de destinatários. Se esse contato fosse um membro de três listas de destinatários, ele teria um ID de contato e três IDs de destinatário, um para cada lista.

Qualtrics 360

Para perguntas Qualtrics 360, entre em contato com nossa equipe de suporte Qualtrics 360.