Em algumas solicitações na API Track CXM, você será perguntado a qual pesquisa se refere à solicitação. Este endpoint lista todas as pesquisas CXM para uma determinada organização.
\nParâmetros Permitidos:
\ninclude_questions:
\nTrue: Exibe as informações detalhadas das perguntas das pesquisas da Track CXM.
\nFalse: Não exibe as informações detalhadas das perguntas das pesquisas da Track CXM.
\nlimit:
\npage:
\n{\n \"data\": {\n \"surveys\": [ //Lista de pesquisas\n {\n \"uuid\": \"...\", //Id\n \"name\": \"...\", //Nome da pesquisa\n \"public_hash\": \"...\" //Identificador(hash) da pesquisa\n \"questions\": [\n {\n \"title\": \"...\", // Titulo da pergunta\n \"type\": \"...\", // Tipo da pergunta\n \"public_hash\": \"...\", // Public Hash da pergunta \n \"is_obligatory\": true,\n \"comments_enabled\": true,\n \"accepted_answers\": \"...\",\n \"composite_metrics\": [\n {\n \"title\": \"Categoria 1\",\n \"type\": \"like_dislike\",\n \"public_hash\": \"ABCD\",\n \"accepted_answers\": {\n \"like\": 1,\n \"dislike\": 0\n },\n }\n ]\n },\n {...}\n },\n {...}\n ]\n }\n}\n\nPara obter o survey_uuid utilize o endpoint de Listar Pesquisas da Track CXM e copie o campo uuid.
\nEsse endpoint permite que você realize a inserção de respostas na plataforma da Track CXM através da API Track CXM. O Body deve seguir o modelo abaixo:
\n[\n {\n \"customer\": {\n \"email\": \"...\",\n \"name\": \"...\",\n \"identificador\": \"...\" // adicionar o valor do atributo identificador da conta, ex: Para caso de CPF, adicionar o dado de CPF do cliente (O atributo identificador fica visível na página de Organização da Track CXM)\n },\n \"interaction\":{\n \"atributo_de_interacao_1\": \"...\",\n \"atributo_de_interacao_2\": \"...\" // adicionar atributos de interação \n },\n \"distribution_channel\": \"11\", //Canal de Distribuição E-mail\n \"response_time\": 11050, //Tempo de Resposta (Opcional) \n \"answered_at\": 1714075101, //Data/Hora da Resposta no formato timestamp | A data de envio é considerada a data de importação das respostas\n \"questions\": [\n {\n \"public_hash\": \"cuWI\", //id da pergunta\n \"answer\": {\n \"response\": 8,//nota do usuário\n \"comment\": \"Muito bom\"//comentário da pergunta\n }\n },\n {\n \"public_hash\": \"usUN\", //id da pergunta\n \"answer\": {\n \"response\": 4\n }\n },\n {\n \"public_hash\": \"bHjJ\", //id da pergunta\n \"answer\": {\n \"response\": 1\n }\n },\n {\n \"public_hash\": \"lTqq\",\n \"answer\":{\n \"comment\": \"Achei pessimo\"\n }\n }\n ]\n }\n]\n\nPara obter o public_hash da pergunta, utilizei o endpoint Listar Pesquisas da CXM, passando o parâmetro include_questions=true.
\nCaso a pergunta seja de like e dislike, basta passar os valores 1 (like) ou 0 (dislike). Exemplo: “response” = 1. O mesmo vale para perguntas da métrica composta.
\nNo campo distribution_channel somente é aceito o valor 11.
\nEste endpoint lista os status de cada cliente participante de uma distribuição da Track CXM via E-mail, SMS Link ou WhatsApp.
\nGET /v1/organizações/{{organization_uuid}}/distribuições/{{distribution_uuid}}/status_de_envio?historico=false&interactipn_attribyutes=false&customer_attributes=false
distribution_uuid (String): Identificador único da distribuição.
history (Booleano): Especifica se deve incluir o histórico de mudanças de status.
false: Apenas o último status de cada cliente dessa distribuição será listado.
true: Todos os status de cada cliente dessa distribuição serão listados, ordenados por status.
interaction_attributes (Booleano): O endpoint pode fornecer os dados com ou sem atributos de interação.
true: Lista todos os atributos da interação.
false: Não lista os atributos da interação.
customer_attributes (Booleano): O endpoint pode fornecer os dados com ou sem atributos de cliente.
true: Lista todos os atributos do cliente.
false: Não lista os atributos do cliente.
page (Inteiro [Opcional]): O endpoint pode fornecer os dados da página solicitada.
Quando esse parametro é informado no endpoint, a resposta vem com a quantidade de registros e paginas total, de acordo com o limit informado
\nQuando esse parâmetro não é informado ou é informado o valor 0 no endpoint, a API retorna a listagem de todos os registros limitados por 50 ou pela quantidade informada no parâmetro limit
Quando o limit não é informado, mas páge sim, o valor do limit padrão é 50
\nlimit (Inteiro [Opcional]): O endpoint pode fornecer a quantidade de registros de acordo com o número informado no parametro limit
Quando esse parametro é informado no endpoint, a resposta vem com a quantidade de registros e paginas total, de acordo com o limit informado
\nValor máximo: 100
\nQuando o page não é informado, mas o limit sim, o valor padrão do page é 1
\nImportante: Caso o endpoint seja utilizado para os canais Link ou QR Code, informaremos apenas o status do sucesso de criação da distribuição, uma vez que não existem envios pela plataforma Track CXM, pois são dependentes do usuário.
\nStatus retornados no endpoint para distribuições via E-mail, SMS Link ou WhatsApp:
\nEnviado
\nRecebido
\nAberta
\nClicada
\nErro - Dropped
\nErro - Bounce
\nErro - Blocked
\nResponse JSON para history=false
\n{\n \"data\": [\n {\n \"name\": \"name\",\n \"phone\": \"1111111111\",\n \"email\": \"email@email.com\",\n \"date\": \"05/01/2023 às 11:08\",\n \"status\": \"Enviado\"\n }\n ],\n \"success\": 1,\n \"message\": \"\"\n}\n\n{\n \"data\": [\n {\n \"name\": \"name\",\n \"phone\": \"1111111111\",\n \"email\": \"email@email.com\",\n \"date\": \"05/01/2023 às 11:08\",\n “status_1“: \"Enviado\",\n “date_2“: \"20/01/2023 às 09:27\",\n “status_2“: \"Recebido\",\n “date_3“: “20/01/2023 às 09:48\",\n \"status_3“: \"Aberto\",\n “date_4“: “20/01/2023 às 09:55\",\n “status_4“: \"Clicado\",\n }\n ],\n \"success\": 1,\n \"message\": \"\"\n}\n\nPara criar uma nova distribuição na Track CXM, será solicitada uma lista contendo os atributos dos clientes. Neste endpoint, você pode listar todos os atributos da organização.
\nParâmetros Permitidos:
\n{\n \"data\": {\n \"atributtes\": [ //Lista de atributos\n {\n \"uuid\": \"...\", //Identificador\n \"name\": \"...\" //Nome do atributo \n },\n {...}\n ],\n }\n}\n\nEsta estrutura retorna todos os atributos existentes na plataforma Track CXM, para uma organização
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Para criar uma nova distribuição na Track CXM, você poderá informar os templates. Neste endpoint, você pode listar todos os templates da organização.
\nParâmetros Permitidos:
\n{\n \"data\": {\n \"templates\": [ //Lista de templates\n {\n \"type\": \"...\",//thanks | expired | invite | reminder\n \"name\": \"...\", //Template nome\n \"public_hash\": \"...\"//Template Hash \n },\n {...}\n ],\n }\n}\n\nEsta estrutura retorna todos os templates disponíveis para a organização, indicando o tipo de cada template, facilitando a seleção e utilização dos mesmos na criação de novas distribuições na plataforma Track CXM.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Para recuperar todas as integrações de uma organizaço na plataforma Track CXM, você pode utilizar o seguinte endpoint. Este endpoint lista todas as integrações onfiguradas para uma determinada organização.
\nParâmetros Permitidos:
\n{\n \"data\": [\n {\n \"uuid\": \"uuid_integracao\",\n \"name\": \"nome_integracao\",\n \"phone\": \"telefone_integracao\",\n \"hash\": \"public_hash_integracao\"\n }\n ],\n \"success\": 1,\n \"message\": \"\"\n}\n\nEste endpoint permite recuperar as notas dos usuários na plataforma Track CXM em formato JSON. A API é atualizada apenas no final do dia. Isso significa que os dados mais recentes disponíveis nela são os do dia anterior. Para garantir que você sempre tenha acesso aos dados mais atualizados, configure a data de consulta como d-1.
\nExemplo: Se hoje for dia 14 de março de 2024, você deve configurar a data final de consulta (end) como 13 de março de 2024.
\nParâmetros Permitidos:
\nanswer_status:
\n1: Interações Respondidas
\n2: Parciais
\n3: Completo e Parcial
\nstart e end (obrigatório):
\nFiltra as interações por intervalo de datas de resposta (até 3 meses).
\nFormato esperado: AAAA-MM-DD
\nsurvey_hash:
\ndistribution_hash:
\nlimit:
\npage:
\nObsevações dos Dados de Retorno:
\nOs dados de retorno relacionados aos atributos de cliente e interação correspondem às informações da linha do arquivo importado para a distribuição à qual a interação pertence.
\n{\n \"data\": {\n \"interactions\": [\n {\n \"uuid\": \"uuid da interação\",\n \"survey\": {\n \"uuid\": \"uuid da pesquisa\",\n \"name\": \"nome da pesquisa\",\n \"public_hash\": \"identificador da pesquisa\"\n },\n \"customer\": {\n \"uuid\": \"uuid do usuário\",\n \"name\": \"nome do usuário\",\n \"email\": \"email do usuário\",\n \"phone\": \"telefone do usuário\",\n \"identifier\": \"identificador do usuário\",\n \"metadata\": [\"atributos de cliente\"]\n },\n \"distribution\": {\n \"uuid\": \"uuid da distribuição\",\n \"distribution_channel\": \"canal de disparo\",\n \"distributed_at\": \"data do disparo\",\n \"public_hash\": \"identificador da pesquisa\"\n },\n \"answered_at\": \"data da resposta\",\n \"health_score\": 100,\n \"answers\": [\n {\n \"item_type\": \"tipo da pergunta\",\n \"question\": \"texto da pergunta\",\n \"answer\": \"nota do usuário\",\n \"comment\": \"comentáro do usuário\",\n \"created_at\": \"data da resposta do usuário\"\n }\n ],\n \"metadata\": [\"atributos de interação\"],\n \"categories\": [\"categorias vinculadas\"],\n \"answer_channel\": \"canal de resposta\"\n }\n ],\n \"total_rows\": 1, /*total de linhas*/ \n \"total_pages\": 1 /*total de páginas*/\n },\n \"success\": 1,\n \"message\": \"\"\n}\n\nPara criar uma nova distribuição na Track CXM, é necessário informar apenas o identificador da pesquisa e as linhas para importação. Todos os demais campos são opcionais.
\nImportante: O import_lines é um array com os dados da interação que serão inseridos no sistema. Neste objeto, além dos dados estáticos como nome do customer, email e phone, poderão ser inseridos atributos de customer e interação que foram previamente cadastrados no sistema.
Canais de distribuição:
\nsmslink
\nAtributos obrigatórios:
\nsurvey_uuid
\ndistribution_channel (smslink, email, whatsapp, link, qrcode, linklist)
\nAtributos para distribuições com lembrete:
\nreminder_channel (smslink, email, whatsapp, link, qrcode, linklist)
\nreminder_at (timestamp)
\nDisparo via WhatsApp:
Para distribuições via WhatsApp, é importante informar o template utilizado.
\"whatsapp_template\": {\n \"name\": \"template-nome-exemplo\",\n \"language\": \"pt_BR\",\n \"variables\": [\"customer.name\", \"interaction.produto\"],\n \"id_provider\": \"ID do template\" //id do template, solicitar ao time de suporte da Track\n }\n\nAssim como o uuid de integração do whatsapp
\n\"whatsapp_integration_uuid\": \"a726be1e-7be0-4add-b983-9c0e46a693db\"//uuid fixo da integração \n\nO número de envio é opcional
\n\"whatsapp_number\": \"5531900000000\"//numero configurado na conta da twilio\n\nPara distribuições via whatsapp que forem configuradas para envio de lembrete, é importante adicionar o template de lembrete além do template da mensagem principal:
\n\"whatsapp_template\": {\n \"name\": \"nome do template\",\n \"language\": \"idioma do template\",\n \"variables\": [\"customer.name\", \"interaction.produto\"] // variáveis necessárias no template\n },\n \"whatsapp_reminder_template\": {\n \"name\": \"nome do template\",\n \"language\": \"idioma do template\",\n \"variables\": [\"customer.name\", \"interaction.produto\"] // variáveis necessárias no template\n }\n\n{\n \"survey_uuid\": \"...\", //(Obrigatório)\n \"distribution_channel\": \"...\", //(Obrigatório) string email | smslink | whatsapp\n \"reminder_channel\": \"...\", //(Opcional) string email | smslink | whatsapp\n \"distribution_name\": \"...\", //(Opcional) string\n \"schedule_at\": \"...\", //(Opcional) timestamp unix 9999999999\n \"validity_at\": \"...\", //(Opcional) timestamp unix 9999999999\n \"reminder_at\": \"...\", //(Opcional) timestamp unix 9999999999\n \"is_anonymous\": \"...\", //(Opcional) bool default false\n \"template_invite_hash\": \"...\",//(Opcional) hash of template type invite\n \"template_reminder_hash\": \"...\",//(Opcional) hash of template type reminder\n \"template_expired_hash\": \"...\",//(Opcional) hash of template type expired\n \"template_thanks_hash\": \"...\",//(Opcional) hash of template type thanks\n \"import_lines\": [\n {\n \"name\": \"...\",\n \"email\": \"...\",\n \"cpf\": \"...\"\n //...\n }\n //{...}\n ],\n \"whatsapp_template\": {\n \"name\": \"template-nome-exemplo\",\n \"language\": \"pt_BR\",\n \"variables\": [\"customer.name\", \"interaction.produto\"], //variáveis presentes no template\n \"id_provider\": \"ID do template\" //id do template, solicitar ao time de suporte da Track \n }, // Obrigatório para distribuições whatsapp\n \"whatsapp_integration_uuid\": \"a726be1e-7be0-4add-b983-9c0e46a693db\"//uuid fixo da integração \n} \n\nPara criar uma nova distribuição do tipo lista de links na Track CXM, você só precisa fornecer o identificador da pesquisa e as linhas para importação, sendo todos os outros campos opcionais.
\nImportante: O import_lines é um array com os dados da interação que serão inseridos no sistema. Neste objeto, além dos dados estáticos como nome do cliente, email e telefone, você pode inserir atributos de cliente e interação que foram previamente cadastrados no sistema.
Observação: O sistema possui um limite de 50 import_lines para requisições com o parâmetro {\"async\": false}. Se o parâmetro for passado como true ou se o import_lines tiver mais itens que o limite estipulado, o processamento será realizado em segundo plano e, assim que finalizado, irá notificar via POST na URL passada como {\"callback_url\": \"...\"}.
{\n \"distribution_uuid\": \"...\",\n \"distribution_name\": \"...\",\n \"callback_url\": \"...\",\n \"shortened_link\": \"...\",\n \"survey_uuid\": \"...\",\n \"validity_at\": \"...\",\n \"template_survey_expired_hash\": \"...\",\n \"template_survey_thanks_hash\": \"...\",\n \"import_lines\": [\n {\n \"name\": \"...\",\n \"email\": \"...\",\n \"cpf\": \"...\"\n //...\n }\n //{...}\n ]\n}\n\n{\n \"survey_uuid\": \"...\", //(Requerido)\n \"distribution_name\": \"...\",//(Opcional) string\n \"validity_at\": \"...\", //(Opcional) timestamp unix 9999999999\n \"async\": true, //(Opcional) bool\n \"shortened_link\": true //(Requerido) bool\n \"callback_url\": \"...\", //(Requerido se async true) url\n \"template_survey_expired_hash\": \"...\",//(Opcional) hash do template type expired\n \"template_survey_thanks_hash\": \"...\",//(Opcional) hash do template type thanks\n \"import_lines\": [\n {\n \"name\": \"...\",\n \"email\": \"...\",\n \"cpf\": \"...\"\n //...\n }\n //{...}\n ]\n}\n\nEste endpoint permite consultar os detalhes de uma distribuição específica na plataforma Track CXM.
\nGET {{url_api}}/v1/organizations/{{organization_uuid}}/distributions/{{distribution_uuid}}
{{organization_uuid}} (String): O identificador único da organização.
{{distribution_uuid}} (String): O identificador único da distribuição.
{{limit}}: Quantidade de registros que serão exibidos por página (Máximo 100 | valor padrão: 100)
{{page}}: Página em que deseja visualizar os registros
A resposta contm informaçes detalhadas da distribuiço
\n{\n \"data\":{\n \"uuid\":\"...\",//string\n \"distribution_name\":\"...\",//string\n \"distribution_chanel\":\"...\",//int\n \"survey_uuid\":\"...\",//string\n \"survey_name\":\"...\",//string\n \"schedule_at\":\"...\",//time\n \"validity_at\":\"...\",//time\n \"reminder_at\":\"...\",//time\n \"counter\":\"...\",//int\n \"distributed_at\":\"...\",//time\n \"added\":\"...\",//int\n \"valid\":\"...\",//int\n \"processed\":\"...\",//int\n \"delivered\":\"...\",//int\n \"opened\":\"...\",//int\n \"clicked\":\"...\",//int\n \"failed\":\"...\",//int\n \"answered\":\"...\",//int\n \"done\":\"...\",//int\n \"partial\":\"...\",//int\n \"invalid\":\"...\",//int\n \"not_delivered\":\"...\",//int\n \"invalid_errors\":{\n \"error_no_customer_counter\":\"...\",//int\n \"error_duplicated_customer_counter\":\"...\",//int\n \"error_duplicated_channel_counter\":\"...\",//int\n \"error_unknown_channel_counter\":\"...\",//int\n \"error_no_channel_counter\":\"...\",//int\n \"error_identifier_format_counter\":\"...\",//int\n \"error_channel_attribute_format_counter\":\"...\",//int\n \"error_parse_counter\":\"...\" //int\n },\n \"not_delivered_errors\":{\n \"error_unsubscribed_channel_counter\":\"...\",//int\n \"error_blockrule_counter\":\"...\",//int\n \"error_blocked_counter\":\"...\",//int\n \"error_quarantine_counter\":\"...\" //int\n },\n \"total_processed_counter\":\"...\",//int\n \"error_response_counter\":\"...\",//int\n \"sender_type\":\"...\",//int\n \"distribution_hash\":\"...\",//string\n \"survey_hash\":\"...\",//string\n \"organization_hash\":\"...\",//string\n \"created_at\":\"...\"//time\n }\n}\n\nEste endpoint permite reenviar uma distribuição específica na plataforma Track CXM.
\nPOST {{url_api}}/v1/organizations/{{organization_uuid}}/distributions/{{distribution_uuid}}/resend
{{organization_uuid}}: O identificador único da organização.
{{distribution_uuid}}: O identificador único da distribuição.
O corpo da requisição deve estar vazio.
\nAuthorization: Token de autenticação.200 OK: O reenvio da distribuição foi bem-sucedido.
404 Not Found: A distribuição especificada não foi encontrada.
Este endpoint permite listar todas as distribuições associadas a uma pesquisa específica na plataforma Track CXM.
\nGET {{url_api}}/v1/organizations/{{organization_uuid}}/distributions/surveys/{{survey_uuid}}
{{organization_uuid}}: O identificador único da organização.
{{survey_uuid}}: O identificador único da pesquisa.
{{limit}}: Quantidade de registros que serão exibidos por página (Máximo 100 | valor padrão: 100)
{{page}}: Página em que deseja visualizar os registros
{{start}}: Data de inicio
{{end}}: Data de fim
Start e End são referentes ao período de criação da distribuição:
\nPeríodo máximo: 3 meses
\nData de inicio deve ser menor que data de fim
\nData de fim deve ser maior que data de inicio
\nSe adicionada data de inicio, deve ser adicionada a data de fim
\nSe adicionada data de fim, deve ser adicionada a data de inicio
\n{\n \"data\": {\n \"distributions\": [\n {\n \"uuid\": \"...\", //string\n \"distribution_name\": \"...\", //string\n \"distribution_chanel\": \"...\", //int\n \"survey_uuid\": \"...\", //string\n \"survey_name\": \"...\", //string\n \"schedule_at\": \"...\", //time\n \"validity_at\": \"...\", //time\n \"reminder_at\": \"...\", //time\n \"counter\": \"...\", //int\n \"distributed_at\": \"...\", //time\n \"added\": \"...\", //int\n \"valid\": \"...\", //int\n \"processed\": \"...\", //int\n \"delivered\": \"...\", //int\n \"opened\": \"...\", //int\n \"clicked\": \"...\", //int\n \"failed\": \"...\", //int\n \"answered\": \"...\", //int\n \"done\": \"...\", //int\n \"partial\": \"...\", //int\n \"invalid\": \"...\", //int\n \"not_delivered\": \"...\", //int\n \"invalid_errors\": {\n \"error_no_customer_counter\": \"...\", //int\n \"error_duplicated_customer_counter\": \"...\", //int\n \"error_duplicated_channel_counter\": \"...\", //int\n \"error_unknown_channel_counter\": \"...\", //int\n \"error_no_channel_counter\": \"...\", //int\n \"error_identifier_format_counter\": \"...\", //int\n \"error_channel_attribute_format_counter\": \"...\", //int\n \"error_parse_counter\": \"...\" //int\n },\n \"not_delivered_errors\": {\n \"error_unsubscribed_channel_counter\": \"...\", //int\n \"error_blockrule_counter\": \"...\", //int\n \"error_blocked_counter\": \"...\", //int\n \"error_quarantine_counter\": \"...\" //int\n },\n \"total_processed_counter\": \"...\", //int\n \"error_response_counter\": \"...\", //int\n \"sender_type\": \"...\", //int\n \"distribution_hash\": \"...\", //string\n \"survey_hash\": \"...\", //string\n \"organization_hash\": \"...\", //string\n \"created_at\": \"...\" //time\n },\n {...}, //Other distributions\n ]\n }\n}\n\nPara exportar os dados na plataforma Track CXM, será necessário informar apenas o recurso que se pretende exportar conforme lista abaixo:
\nInterações int: 1
Clientes int: 2
Distribuições int: 3
Pesquisas int: 6
Loops int: 7
survey_hash (String): O identificador único da pesquisa. Pode ser utilizado para filtrar os dados referentes a uma pesquisa específica em exportações de interações e distribuições.
\nwith_quotes (Boolean): Este atributo é responsável por fornecer uma formatação diferente para o arquivo CSV gerado.
\ntrue: Se informado como \"true\", o CSV será gerado com os campos de texto entre aspas e a separação dos campos será feita utilizando ponto e vírgula (;).
\nfalse: Se informado como \"false\", os campos de texto não estarão entre aspas e a separação dos campos será feita utilizando vírgula (,).O atributo \"with_quotes\" se aplica a todas as tipos de exportações disponíveis.
\ndistribution_hash (String): O identificador único da distribuiço. Pode ser utilizado para filtrar os dados referentes a uma distribuiço específica em exportações de interações.
\nanswer_status (Inteiro): Status atual da resposta do cliente para a pesquisa em exportações de interações, podendo ser:
\nTotalmente respondidas = 1
\nParcialmente respondidas = 2
\nTotalmente ou Parcialmente respondidas = 3
\nloop_uuid (String): Identificador único do grupo de loop. Pode ser utilizado para filtrar os dados referentes a um grupo de loop específico em exportações de loops.
\ndealt_status (Inteiro): Status atual do ticket do loop em exportações de loops, podendo ser:
\nAbertos = 1
\nEm Andamento = 2
\nConcluído = 3
\nBody:\n{\n \"survey_hash\": \"ABCD\",\n \"with_quotes\": true, \n \"distribution_hash\": \"ABCD\",\n \"answer_status\": 1 ,\n \"loop_uuid\": \"ABCD\",\n \"dealt_status\": 2 \n}\n\nA resposta é apenas o código de status 200 se tudo estiver ok.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Este endpoint permite listar todas as exportações de dados realizadas na plataforma Track CXM.
\nGET {{url_api}}/v1/organizations/{{organization_uuid}}/exports
{{organization_uuid}}: O identificador único da organização.A resposta será uma lista de todas as exportações realizadas, incluindo informações sobre cada exportação, como o recurso exportado, a data e hora da exportação, entre outros.
\n{\n \"data\": {\n \"exports\": [\n {\n \"uuid\": \"...\",\n \"name\": \"...\",\n \"status\": \"...\",\n \"csv_url\": \"...\",\n \"created_at\": \"...\"\n },\n {...} //Exports\n ]\n }\n}\n\nUm webhook é uma forma elegante de ser notificado sempre que houver um evento em suas pesquisas na plataforma Track CXM. Siga as etapas abaixo para configurar e receber notificações via POST em seu sistema.
\nPara configurar o webhook é necessário acessar seu painel na plataforma track.co e navegar para:
\nAcesse o painel de administração na plataforma Track CXM.
\nNavegue para as configurações da sua conta.
\nProcure a seção de integrações.
\nAtive a opção para configurar um novo webhook.
\nInsira o URL de destino para as notificações do webhook. Certifique-se de que este URL seja acessível pelo seu sistema e esteja configurado para receber e processar solicitações POST.
\nEscolha quais eventos você deseja receber notificações. Por exemplo, você pode optar por receber notificações para novas respostas, atualizações de distribuições, etc.
\nDepois de configurado corretamente o webhook seu sistema irá receber notificações via POST sempre que houver algum evento.
\n{\n \"events\": [\n {\n \"type\": \"...\",\n \"interaction_uuid\": \"...\", // uuid v4\n \"distribution_uuid\": \"...\", // uuid v4\n \"survey_uuid\": \"...\", // uuid v4\n \"survey_name\": \"...\", // string\n \"survey_public_hash\": \"...\", // string\n \"answered_at\": \"...\", // unix timestamp (integer)\n \"distributed_at\": \"...\", // unix timestamp (integer)\n \"answered_channel\": \"...\", // web, widget, sms\n \"distribution_channel\": \"...\", // email, sms, widget, link, linklist, qrcode\n \"health_score\": \"...\", // integer\n \"answers\": [\n {\n \"item_uuid\": \"...\", // uuid v4\n \"question_type\": \"...\", // nps_relational, nps_transactional, ces, ces2, csat, ratings, emoji, thumbs, multiple_choice, open\n \"question\": \"...\", // string\n \"answer\": \"...\", // string or array for multiple_choice (Ex.: [\"answer A\",\"answer B\"])\n \"comment\": \"...\", // string\n \"other_option\": \"...\" // string (outra opção para múltipla escolha)\n },\n {...}\n ],\n \"customer\": {\n \"name\": \"...\", // string\n \"email\": \"...\", // email string\n \"phone\": \"...\", // integer\n \"attributes\": [\n {\n \"uuid\": \"...\", // uuid v4\n \"name\": \"...\", // string\n \"value\": \"...\" // string\n }\n ]\n },\n \"interaction_attributes\": [\n {\n \"uuid\": \"...\", // string\n \"name\": \"...\", // string\n \"value\": \"...\" // string\n }\n ]\n }\n ]\n}\n\nEste endpoint permite listar todas as distribuições de todas as pesquisas vinculadas à um determinado grupo de pesquisa.
\nGET /v1/organizations/{{organization_uuid}}/distributions/survey-groups/{{survey_group_uuid}}?start=2026-03-01&end=2026-03-02&limit=10&page=1
distribution_uuid (String): Identificador único da distribuição.
survey_group_uuid (String): Identificador único do grupo de pesquisa.
start e end (ambos obrigatórios, se forem usados):
\nFiltra as interações por intervalo de datas de resposta (até 3 meses).
\nFormato esperado: AAAA-MM-DD
\nlimit:
\npage:
\n{\n \"data\": {\n \"distribution\": [\n {\n \"uuid\": \"0b1caa77-0f6e-4b9e-9637-faa3cf6dbd6c\",\n \"distribution_name\": \"Anônima 3/12/2026, 5:11:05 PM\",\n \"distribution_chanel\": 6,\n \"survey_uuid\": \"33b2ba35-d466-4eea-95e5-0b5ecdf47f4d\",\n \"survey_name\": \"xxxx\",\n \"schedule_at\": null,\n \"validity_at\": null,\n \"reminder_at\": null,\n \"counter\": 1,\n \"distributed_at\": 0,\n \"added\": 0,\n \"valid\": 0,\n \"processed\": 0,\n \"delivered\": 0,\n \"opened\": 0,\n \"clicked\": 0,\n \"answered\": 0,\n \"done\": 0,\n \"partial\": 0,\n \"failed\": 0,\n \"invalid\": 0,\n \"not_delivered\": 0,\n \"invalid_errors\": {\n \"error_channel_attribute_format_counter\": 0,\n \"error_duplicated_channel_counter\": 0,\n \"error_duplicated_customer_counter\": 0,\n \"error_identifier_format_counter\": 0,\n \"error_no_channel_counter\": 0,\n \"error_no_customer_counter\": 0,\n \"error_parse_counter\": 0,\n \"error_unknown_channel_counter\": 0\n },\n \"not_delivered_errors\": {\n \"error_blocked_counter\": 0,\n \"error_blockrule_counter\": 0,\n \"error_quarantine_counter\": 0,\n \"error_unsubscribed_channel_counter\": 0\n },\n \"error_response_counter\": 0,\n \"sender_type\": 0,\n \"survey_hash\": \"xxxx\",\n \"distribution_hash\": \"xxxx\",\n \"organization_hash\": \"xxxx\",\n \"created_at\": 1773346281\n }\n ],\n \"total\": 1,\n \"pages\": 1,\n \"current_page\": 1,\n \"per_page\": 100\n },\n \"success\": 1,\n \"message\": \"\",\n \"cache_timestamp\": 0\n}\n\nData de ínicio (obrigatório se tiver end)
\n","type":"text/plain"},"key":"start","value":"2026-03-01"},{"disabled":true,"description":{"content":"Data de fim (obrigatório se tiver start)
\n","type":"text/plain"},"key":"end","value":"2026-03-02"},{"disabled":true,"description":{"content":"Quantidade de itens por página (opcional)
\n","type":"text/plain"},"key":"limit","value":"10"},{"disabled":true,"description":{"content":"Número da página (opcional)
\n","type":"text/plain"},"key":"page","value":"1"}],"variable":[]}},"response":[],"_postman_id":"6f9a334f-8850-4ef9-9d2c-a4cfa11712fc"}],"id":"6652cff6-2332-4209-b2c2-865f3a087923","description":"Sua porta de entrada para uma integração completa e personalizada
\nA Track CXM coloca à disposição de seus clientes uma API robusta, permitindo a integração perfeita da nossa plataforma com diversos outros sistemas. Através da API Track CXM, você tem acesso a um universo de funcionalidades que facilitam a coleta, o tratamento e a análise de dados, impulsionando a experiência do cliente em sua empresa.
\nDistribuição de pesquisas e extração de dados sob medida
\nCom a API Track CXM, você tem o poder de:
\nDistribuir pesquisas armazenadas da Track CXM de forma estratégica: Crie e distribua pesquisas personalizadas para diferentes públicos, coletando feedback valioso e insights acionáveis que impulsionam a satisfação do cliente.
\nExtrair dados armazenados da Track CXM com precisão: Acesse e extraia dados relevantes de forma automatizada, enriquecendo sua base de conhecimento e otimizando processos internos.
\nRealizar ações personalizadas para sua organização através de dados armazenados na Track CXM: Automatize tarefas e workflows com base nos dados coletados, agilizando a resolução de problemas e aprimorando a experiência do cliente.
\nIntegração sob medida para suas necessidades
\nA API Track CXM foi projetada para oferecer flexibilidade total, permitindo que você personalize a integração de acordo com as necessidades específicas do seu negócio. Seja qual for o seu cenário, a Track CXM oferece a solução ideal para integrar-se perfeitamente à sua infraestrutura tecnológica.
\nExplore mais recursos de integração Track CXM
\nA Track CXM vai além da API, oferecendo diversas outras opções de integração para atender às suas necessidades:
\nIntegração via Webhook na Track CXM: Receba notificações em tempo real sobre eventos importantes da plataforma Track CXM.
\nIntegração via SFTP na Track CXM: Transfira dados de forma segura e automatizada entre a Track CXM e seus sistemas.
\nIntegração via Widget na Track CXM: Integre a Track CXM diretamente em seu site ou aplicativo, coletando feedback instantâneo dos seus clientes.
\nAcesse a Central de Ajuda Track CXM para mais informações
\nPara saber mais sobre os recursos da API Track CXM, tirar dúvidas sobre a plataforma ou explorar outras opções de integração, acesse nossa Central de Ajuda completa e detalhada. Nossa equipe de especialistas está sempre à disposição para te auxiliar em cada etapa da sua jornada de integração.
\nLembre-se:
\nAntes de iniciar a integração com a Track CXM, é fundamental ler toda a documentação com atenção. Os terminais da API são organizados de forma linear e complementar, garantindo uma integração completa e eficiente.
\nCom a API Track CXM, você tem tudo para transformar a experiência do cliente em sua empresa. Comece hoje mesmo a integrar a Track CXM e desfrute dos benefícios de uma plataforma completa e versátil.
\nGarantindo acesso seguro e personalizado à API Track CXM
\nPara garantir uma integração segura e personalizada com a API Track CXM, é necessário utilizar um token de autenticação exclusivo e o identificador da sua organização. Esses dados funcionam como chaves de acesso que permitem à API Track CXM identificar e validar sua requisição, assegurando que apenas usuários autorizados possam acessar os recursos da plataforma.
\nObtendo suas credenciais de autenticação da API Track CXM:
\nAcesse seu painel na plataforma Track CXM: Inicie o processo de autenticação acessando o painel de controle da Track CXM com suas credenciais de login habituais.
\nDentro da plataforma Track CXM, navegue para Configurações > Integrações > API: No menu principal do painel, localize a seção \"Configurações\" e, em seguida, clique em \"Integrações\". Dentro da área de integrações, selecione a opção \"API\".
\nAtive a integração via API Track CXM: Para habilitar o uso da API Track CXM, clique no botão \"Ativar API\". Essa ação permitirá que você gere o token de autenticação e o identificador da organização necessários para a integração.
\nRecupere seu TOKEN e UUID da organização armazenados na plataforma Track CXM: Após ativar a API Track CXM, você terá acesso ao seu token de autenticação único e ao identificador da organização (UUID). Armazene essas informações com segurança, pois serão essenciais para realizar solicitações à API Track CXM.
\nObservações importantes:
\nSegurança em primeiro lugar para acesso à API Track CXM: O token de autenticação e o identificador da organização são informações confidenciais. Mantenha-os em local seguro e evite compartilhá-los com terceiros.
\nSuporte da Track CXM ao seu alcance: Em caso de dúvidas ou dificuldades durante o processo de obtenção das credenciais de autenticação, entre em contato com nossa equipe de suporte técnico da Track CXM. Estamos sempre à disposição para auxiliar e garantir uma experiência de integração tranquila e eficiente.
\nCom o token de autenticação e o identificador da organização em mãos, você estará pronto para desfrutar de todos os recursos da API Track CXM e realizar integrações personalizadas que impulsionarão a experiência do cliente em sua empresa.
\nAs chamadas da nossa API são limitadas em 2.000 requisições por minuto. A integração deverá se adequar a este limite para evitar que as requisições retornem erro.
\nEm todas as solicitações para a API Track CXM será necessário informar um Bearer token no cabeçalho da requisição:
Authorization: Bearer {{token_here}}\n\nTodas as respostas da API Track CXM seguem o padrão JSON. Este também é o padrão no qual o cliente deve passar os dados na solicitação.
Envie no cabeçalho: Content-Type:application/json
Todas requisições da documentação da API Track CXM devem ser efetuadas para: https://api.track.co
Sempre que o código de status http retornado pela API Track CXM for diferente de 200, o servidor responderá com o seguinte padrão:
{\n \"message\": \"\",\n \"success\": \"\"\n}\n\nThis endpoint retrieves a list of surveys available for a given organization on the Track CXM platform.
\nGET /v1/organizations/{{organization_uuid}}/surveys
include_questions (Boolean): Specifies whether detailed question information should be displayed.
True: Displays detailed question information.
False: Does not display detailed question information.
limit (Integer): Number of records per page.
page (Integer): Page number to be displayed in pagination.
The response will contain a list of surveys with their basic information such as survey ID, name, and creation date.
\n{\n \"data\": {\n \"surveys\": [ //Lista de pesquisas\n {\n \"uuid\": \"...\", //Id\n \"name\": \"...\", //Nome da pesquisa\n \"public_hash\": \"...\" //Identificador(hash) da pesquisa\n \"questions\": [\n {\n \"title\": \"...\", // Titulo da pergunta\n \"type\": \"...\", // Tipo da pergunta\n \"public_hash\": \"...\", // Public Hash da pergunta \n \"is_obligatory\": true,\n \"comments_enabled\": true,\n \"accepted_answers\": \"...\",\n \"composite_metrics\": [\n {\n \"title\": \"Categoria 1\",\n \"type\": \"like_dislike\",\n \"public_hash\": \"ABCD\",\n \"accepted_answers\": {\n \"like\": 1,\n \"dislike\": 0\n },\n }\n ]\n },\n {...}\n },\n {...}\n ]\n }\n}\n\nThis endpoint enables the insertion of responses into the Track CXM platform via the API Track CXM.
\nPOST /v1/organizations/{{organization_uuid}}/surveys/{{survey_uuid}}/answers
The request body must follow the model below:
\n[\n {\n \"customer\": {\n \"email\": \"...\",\n \"name\": \"...\",\n \"identificador\": \"...\" add the value of the account identifier attribute, e.g.: In the case of CPF, add the customer's CPF data (The identifier attribute is visible on the Track CXM Organization page)\n },\n \"interaction\":{\n \"interaction_attribute_1\": \"...\",\n \"interaction_attribute_2\": \"...\" \n },\n \"distribution_channel\": \"11\", //Distribution Channel Email\n \"response_time\": 11050, //Response Time (Optional)\n \"answered_at\": 1714075101, //Response Date/Time in timestamp format\n \"questions\": [\n {\n \"public_hash\": \"cuWI\", //question id\n \"answer\": {\n \"response\": 8,//user note\n \"comment\": \"Very good\"//question comment\n }\n },\n {\n \"public_hash\": \"usUN\", //question id\n \"answer\": {\n \"response\": 4\n }\n },\n {\n \"public_hash\": \"bHjJ\", //question id\n \"answer\": {\n \"response\": 1\n }\n },\n {\n \"public_hash\": \"lTqq\",\n \"answer\":{\n \"comment\": \"I thought it was terrible\"\n }\n }\n ]\n }\n]\n\nTo obtain the public_hash of the question, I used the List Surveys endpoint, passing the include_questions=true parameter.
\nIf the question is about like and dislike, simply enter the values 1 (like) or 0 (dislike). Example: “response” = 1. The same goes for composite metric questions.
\nIn the distribution channel field, I only accept channels 11: api
\nThis endpoint retrieves the status of each customer participating in a distribution via Email, SMS Link, or WhatsApp on the Track CXM platform.
\nGET /v1/organizações/{{organization_uuid}}/distribuições/{{distribution_uuid}}/status_de_envio?historico=false&interactipn_attribyutes=false&customer_attributes=false
distribution_uuid (String): The unique identifier of the distribution.history (Boolean): Specifies whether to include status change history.
false: Only the last status for each client of that distribution will be listed.
true: All statuses of each client of that distribution will be listed, sorted by status.
interaction_attributes (Boolean):The endpoint can provide the data with or without interaction attributes
true: list all attributes of that interactioncustomer_attributes (Boolean): The endpoint can provide the data with or without customer attributes:
true: list all attributes of that customerpage Integer [Optional]): The endpoint can provide the data for the requested page.
When this parameter is provided in the endpoint, the response includes the total number of records and pages, according to the specified limit.
\nWhen this parameter is not provided or the value 0 is provided in the endpoint, the API returns the list of all records limited by 50 or by the quantity provided in the limit parameter
When the limit is not provided but the page is, the default limit value is 50.
\nlimit (Integer [Optional]): The endpoint can provide the number of records based on the number specified in the limit parameter.
When this parameter is provided in the endpoint, the response includes the total number of records and pages, according to the specified limit.
\nMaximum value: 100
\nWhen the page is not provided but the limit is, the default value for the page is 1.
\nImportant: If the endpoint is used for the Link or QR Code channels, we will only report the status of the successful creation of the distribution, since there are no shipments through the platform since they are dependent on the user.
\nStatuses returned on the endpoint for distributions via Email, SMS Link or WhatsApp:
\nEnviado (Sent)
\nRecebido (Received)
\nAberta (Opened)
\nClicada (Clicked)
\nError - Dropped
\nError - Bounce
\nError - Blocked
\n{\n \"data\": [\n {\n \"name\": \"name\",\n \"phone\": \"1111111111\",\n \"email\": \"email@email.com\",\n \"date\": \"05/01/2023 às 11:08\",\n \"status\": \"Enviado\"\n }\n ],\n \"success\": 1,\n \"message\": \"\"\n}\n\n{\n \"data\": [\n {\n \"name\": \"name\",\n \"phone\": \"1111111111\",\n \"email\": \"email@email.com\",\n \"date\": \"05/01/2023 às 11:08\",\n “status_1“: \"Enviado\",\n “date_2“: \"20/01/2023 às 09:27\",\n “status_2“: \"Recebido\",\n “date_3“: “20/01/2023 às 09:48\",\n \"status_3“: \"Aberto\",\n “date_4“: “20/01/2023 às 09:55\",\n “status_4“: \"Clicado\",\n }\n ],\n \"success\": 1,\n \"message\": \"\"\n}\n\nThis endpoint retrieves a list of all attributes of the organization on the Track CXM platform, which can be used when creating a new distribution and providing customer details.
\nGET /v1/organizations/{{organization_uuid}}/attributes
The response will be a JSON containing a list of attributes of the organization.
\n{\n \"data\": {\n \"atributtes\": [ //List of atributtes\n {\n \"uuid\": \"...\", //Atributte identifier\n \"name\": \"...\" //Atributte name \n },\n {...}\n ],\n }\n}\n\nThis endpoint retrieves a list of all templates of the organization on the Track CXM platform, which can be used when creating a new distribution and selecting templates.
\nGET /v1/organizations/{{organization_uuid}}/templates
The response will be a JSON containing a list of templates of the organization.
\n{\n \"data\": {\n \"templates\": [ //List of templates\n {\n \"type\": \"...\",//thanks | expired | invite | reminder\n \"name\": \"...\", //Template name\n \"public_hash\": \"...\"//Template Hash \n },\n {...}\n ],\n }\n}\n\nTo retrieve all integrations of an organization on the Track CXM platform, you can use the following endpoint. This endpoint lists all integrations configured for a specific organization.
\nGET /organizations/{organization_uuid}/integrations
organization_uuid (String): The unique identifier of the organization whose WhatsApp integrations you want to list.The response will be a JSON containing a list of all integrations configured for the organization.
\n{\n \"data\": [\n {\n \"uuid\": \"integration_uuid\",\n \"name\": \"integration_name\",\n \"phone\": \"integration_phone\",\n \"hash\": \"integration_hash\"\n }\n ],\n \"success\": 1,\n \"message\": \"\"\n}\n\nThis endpoint enables the retrieval of user notes in JSON format on the Track CXM platform. The API is updated only at the end of the day. This means that the most recent data available in it is from the previous day. To ensure that you always have access to the most up-to-date data, configure the query date as d-1.
\nGET /v1/organizations/{{organization_uuid}}/interactions
answer_status (Integer): Specifies the status of interactions to filter by.
1: Responded Interactions
2: Partial Interactions
3: Complete and Partial Interactions
start (Date, Required): Start date of the response date range. Format: YYYY-MM-DD.
end (Date, Required): End date of the response date range. Format: YYYY-MM-DD.
survey_hash (String): Filters interactions by the public hash/identifier of the survey.
distribution_hash (String): Filters interactions by the public hash of the distribution.
limit (Integer): Number of records per page (maximum of 100).
page (Integer): Page number to be displayed in pagination.
Return Data Notes:
\nThe return data related to the customer and interaction attributes correspond to the information from the row of the imported file for the distribution to which the interaction belongs.
\n{\n \"data\": {\n \"interactions\": [\n {\n \"uuid\": \"Unique identifier for the interaction\",\n \"survey\": {\n \"uuid\": \"Unique identifier for the survey\",\n \"name\": \"Name of the survey\",\n \"public_hash\": \"Public identifier for the survey\"\n },\n \"customer\": {\n \"uuid\": \"Unique identifier for the user\",\n \"name\": \"Name of the user.\",\n \"email\": \"Email address of the user\",\n \"phone\": \"Phone number of the user\",\n \"identifier\": \"User identifier within the platform\",\n \"metadata\": [\"List of additional user attributes\"]\n },\n \"distribution\": {\n \"uuid\": \"Unique identifier for the distribution\",\n \"distribution_channel\": \"Channel used to send the survey\",\n \"distributed_at\": \"Date and time the survey was sent\",\n \"public_hash\": \"Public identifier for the distribution\"\n },\n \"answered_at\": \"Date and time the user responded to the survey\",\n \"health_score\": 100,\n \"answers\": [\n {\n \"item_type\": \"Type of the answered question\",\n \"question\": \"Text of the answered question\",\n \"answer\": \"User's rating for the question\",\n \"comment\": \"User's additional comment for the question\",\n \"created_at\": \"Date and time the user answered the question\"\n }\n ],\n \"metadata\": [\"List of additional interaction attributes\"],\n \"categories\": [\"Categories associated with the interaction\"],\n \"answer_channel\": \"Channel used by the user to respond to the survey\"\n }\n ],\n \"total_rows\": 1, /*Total number of rows in the query*/ \n \"total_pages\": 1 /*Total number of pages with results for the query*/\n },\n \"success\": 1,\n \"message\": \"\"\n}\n\nTo create a new distribution in Track CXM plataform, it is necessary to inform only the research identifier and the lines for import, all other fields being optional.
\nImportant: import_lines is an array with the interaction data that will be inserted in the system, in this object, in addition to the static data such as customer name, email, and phone, customer and interaction attributes that were previously registered can be inserted in the system.
\nResponse is only http status code 200 if all is ok.
\nsmslink
\nMandatory attributes:
\nsurvey_uuid
\ndistribution_channel (smslink, email, whatsapp, link, qrcode, linklist)
\nAttributes for distributions with reminder:
\nreminder_channel (smslink, email, whatsapp, link, qrcode, linklist)
\nreminder_at (timestamp)
\nFor distributions via WhatsApp, it is important to inform the used template:
\n \"whatsapp_template\": {\n \"name\": \"template-nome-exemplo\", // template name\n \"language\": \"pt_BR\", // template language\n \"variables\": [\"customer.name\", \"interaction.produto\"], //variables present in the template\n \"id_provider\": \"ID do template\" //template id, ask Track support team\n }\n\nAlso, the WhatsApp integration UUID is necessary:
\"whatsapp_integration_uuid\": \"integration_uuid\" // Mandatory for WhatsApp distributions
For distributions via WhatsApp that are configured to send reminders, it is important to add the reminder template in addition to the main message template:
\n\"whatsapp_template\": {\n \"name\": \"template name\",\n \"language\": \"template language\",\n \"variables\": [\"customer.name\", \"interaction.product\"] // variables required in the template\n},\n\"whatsapp_reminder_template\": {\n \"name\": \"template name\",\n \"language\": \"template language\",\n \"variables\": [\"customer.name\", \"interaction.product\"] // variables required in the template\n}\n\n{\n \"survey_uuid\": \"...\", //(Required)\n \"distribution_channel\": \"...\", //(Required) string email | smslink | whatsapp\n \"reminder_channel\": \"...\", //(Optional) string email | smslink | whatsapp\n \"distribution_name\": \"...\", //(Optional) string\n \"schedule_at\": \"...\", //(Optional) timestamp unix 9999999999\n \"validity_at\": \"...\", //(Optional) timestamp unix 9999999999\n \"reminder_at\": \"...\", //(Optional) timestamp unix 9999999999\n \"is_anonymous\": \"...\", //(Optional) bool default false\n \"template_invite_hash\": \"...\",//(Optional) hash of template type invite\n \"template_reminder_hash\": \"...\",//(Optional) hash of template type reminder\n \"template_expired_hash\": \"...\",//(Optional) hash of template type expired\n \"template_thanks_hash\": \"...\",//(Optional) hash of template type thanks\n \"import_lines\": [\n {\n \"name\": \"...\",\n \"email\": \"...\",\n \"cpf\": \"...\"\n //...\n }\n //{...}\n ],\n \"whatsapp_template\": {\n \"name\": \"template-name-example\",\n \"language\": \"en_US\",\n \"variables\": [\"customer.name\", \"interaction.produto\"], \n \"id_provider\": \"ID do template\" //template id, ask Track support team\n }, // Required for whatsapp distribution\n \"whatsapp_integration_uuid\": \"a726be1e-7be0-4add-b983-9c0e46a693db\"//static uuid\n}\n\nTo create a new linklist distribution in Track CXM plataform, it is necessary to inform only the research identifier and the lines for import, all other fields being optional.
\nImportant: import_lines is an array with the interaction data that will be inserted in the system, in this object, in addition to the static data such as customer name, email, and phone, customer and interaction attributes that were previously registered can be inserted in the system
\nNote: the system has a limit of 50 import_lines for requests with parameter{\"async\": false}if the parameter is passed as true or the import_lines has more items than the stipulated limit, processing will be performed in backgroud and once finished will notify POST in the url passed as {\"callback_url\": \"...\"}.
{\n \"distribution_uuid\": \"...\",\n \"distribution_name\": \"...\",\n \"callback_url\": \"...\",\n \"shortened_link\": \"...\",\n \"survey_uuid\": \"...\",\n \"validity_at\": \"...\",\n \"template_expired_hash\": \"...\",\n \"template_thanks_hash\": \"...\",\n \"import_lines\": [\n {\n \"name\": \"...\",\n \"email\": \"...\",\n \"cpf\": \"...\"\n //...\n }\n //{...}\n ]\n}\n\n{\n \"survey_uuid\": \"...\", //(Required)\n \"distribution_name\": \"...\",//(Optional) string\n \"validity_at\": \"...\", //(Optional) timestamp unix 9999999999\n \"async\": true, //(Optional) bool\n \"shortened_link\": true //(Required) bool\n \"callback_url\": \"...\", //(Required if async true) url\n \"template_survey_expired_hash\": \"...\",//(Optional) hash of template type expired\n \"template_survey_thanks_hash\": \"...\",//(Optional) hash of template type thanks\n \"import_lines\": [\n {\n \"name\": \"...\",\n \"email\": \"...\",\n \"cpf\": \"...\"\n //...\n }\n //{...}\n ]\n}\n\nThis endpoint allows querying the details of a specific distribution on the Track CXM platform.
\nGET {{url_api}}/v1/organizations/{{organization_uuid}}/distributions/{{distribution_uuid}}
{{organization_uuid}} (String): The unique identifier of the organization.
{{distribution_uuid}} (String): The unique identifier of the distribution.
{{limit}}: Number of records to display per page (Maximum 100 | Default value: 100)
{{page}}: Page where you want to view the records
The response will contain detailed information about the specified distribution.
\n{\n \"data\":{\n \"uuid\":\"...\",//string\n \"distribution_name\":\"...\",//string\n \"distribution_chanel\":\"...\",//int\n \"survey_uuid\":\"...\",//string\n \"survey_name\":\"...\",//string\n \"schedule_at\":\"...\",//time\n \"validity_at\":\"...\",//time\n \"reminder_at\":\"...\",//time\n \"counter\":\"...\",//int\n \"distributed_at\":\"...\",//time\n \"added\":\"...\",//int\n \"valid\":\"...\",//int\n \"processed\":\"...\",//int\n \"delivered\":\"...\",//int\n \"opened\":\"...\",//int\n \"clicked\":\"...\",//int\n \"failed\":\"...\",//int\n \"answered\":\"...\",//int\n \"done\":\"...\",//int\n \"partial\":\"...\",//int\n \"invalid\":\"...\",//int\n \"not_delivered\":\"...\",//int\n \"invalid_errors\":{\n \"error_no_customer_counter\":\"...\",//int\n \"error_duplicated_customer_counter\":\"...\",//int\n \"error_duplicated_channel_counter\":\"...\",//int\n \"error_unknown_channel_counter\":\"...\",//int\n \"error_no_channel_counter\":\"...\",//int\n \"error_identifier_format_counter\":\"...\",//int\n \"error_channel_attribute_format_counter\":\"...\",//int\n \"error_parse_counter\":\"...\" //int\n },\n \"not_delivered_errors\":{\n \"error_unsubscribed_channel_counter\":\"...\",//int\n \"error_blockrule_counter\":\"...\",//int\n \"error_blocked_counter\":\"...\",//int\n \"error_quarantine_counter\":\"...\" //int\n },\n \"total_processed_counter\":\"...\",//int\n \"error_response_counter\":\"...\",//int\n \"sender_type\":\"...\",//int\n \"distribution_hash\":\"...\",//string\n \"survey_hash\":\"...\",//string\n \"organization_hash\":\"...\",//string\n \"created_at\":\"...\"//time\n }\n}\n\nThis endpoint allows resending a specific distribution on the Track CXM platform.
\nPOST {{url_api}}/v1/organizations/{{organization_uuid}}/distributions/{{distribution_uuid}}/resend
{{organization_uuid}} (String): The unique identifier of the organization.
{{distribution_uuid}} (String): The unique identifier of the distribution.
The request body should be empty.
\nAuthorization: Authentication token.200 OK: The distribution resend was successful.
404 Not Found: The specified distribution was not found.
This endpoint allows listing all distributions associated with a specific survey on the Track CXM platform.
\nGET {{url_api}}/v1/organizations/{{organization_uuid}}/distributions/surveys/{{survey_uuid}}
{{organization_uuid}} (String): The unique identifier of the organization.
{{survey_uuid}} (String): The unique identifier of the survey.
{{limit}}: Number of records to display per page (Maximum 100 | Default value: 100)
{{page}}: Page where you want to view the records
{{start}}: Start date
{{end}}End date
Start and End refer to the distribution creation period:
\nMaximum period: 3 months
\nStart date must be earlier than end date
\nEnd date must be later than start date
\nIf a start date is provided, an end date must also be provided
\nIf an end date is provided, a start date must also be provided
\nThe response will contain a list of distributions associated with the specified survey.
\n{\n \"data\": {\n \"distributions\": [\n {\n \"uuid\": \"...\", //string\n \"distribution_name\": \"...\", //string\n \"distribution_chanel\": \"...\", //int\n \"survey_uuid\": \"...\", //string\n \"survey_name\": \"...\", //string\n \"schedule_at\": \"...\", //time\n \"validity_at\": \"...\", //time\n \"reminder_at\": \"...\", //time\n \"counter\": \"...\", //int\n \"distributed_at\": \"...\", //time\n \"added\": \"...\", //int\n \"valid\": \"...\", //int\n \"processed\": \"...\", //int\n \"delivered\": \"...\", //int\n \"opened\": \"...\", //int\n \"clicked\": \"...\", //int\n \"failed\": \"...\", //int\n \"answered\": \"...\", //int\n \"done\": \"...\", //int\n \"partial\": \"...\", //int\n \"invalid\": \"...\", //int\n \"not_delivered\": \"...\", //int\n \"invalid_errors\": {\n \"error_no_customer_counter\": \"...\", //int\n \"error_duplicated_customer_counter\": \"...\", //int\n \"error_duplicated_channel_counter\": \"...\", //int\n \"error_unknown_channel_counter\": \"...\", //int\n \"error_no_channel_counter\": \"...\", //int\n \"error_identifier_format_counter\": \"...\", //int\n \"error_channel_attribute_format_counter\": \"...\", //int\n \"error_parse_counter\": \"...\" //int\n },\n \"not_delivered_errors\": {\n \"error_unsubscribed_channel_counter\": \"...\", //int\n \"error_blockrule_counter\": \"...\", //int\n \"error_blocked_counter\": \"...\", //int\n \"error_quarantine_counter\": \"...\" //int\n },\n \"total_processed_counter\": \"...\", //int\n \"error_response_counter\": \"...\", //int\n \"sender_type\": \"...\", //int\n \"distribution_hash\": \"...\", //string\n \"survey_hash\": \"...\", //string\n \"organization_hash\": \"...\", //string\n \"created_at\": \"...\" //time\n },\n {...}, //Other distributions\n ]\n }\n}\n\nTo export data of Track CXM plataform, it will be necessary to inform only the resource you intend to export according to the list below:
\nInteractions int: 1
Customers int: 2
Distributions int: 3
Surveys int: 6
Loops int: 7
survey_hash (String): The unique identifier of the survey. It can be used to filter data related to a specific survey in exports of interactions and distributions.
\nwith_quotes (Boolean): This attribute is responsible for providing a different formatting for the generated CSV file.
\ntrue: If set to \"true\", the CSV will be generated with text fields enclosed in quotes and fields separated by semicolons (;).
\nfalse: If set to \"false\", text fields will not be enclosed in quotes, and fields will be separated by commas (,).The \"with_quotes\" attribute applies to all types of available exports.
\ndistribution_hash (String): The unique identifier of the distribution. It can be used to filter data related to a specific distribution in exports of interactions .
\nanswer_status (Integer): Current status of the customer's response to the survey, which can be:
\nFully answered = 1
\nPartially answered = 2
\nFully or Partially answered = 3
\nloop_uuid (String): Unique identifier of the loop group. It can be used to filter data related to a specific loop group in loop exports.
\ndealt_status (Integer): Current status of the loop ticket in loop exports, which can be:
\nOpen = 1
\nIn Progress = 2
\nCompleted = 3
\nBody\n{\n \"survey_hash\": \"ABCD\",\n \"with_quotes\": true,\n \"distribution_hash\": \"ABCD\",\n \"answer_status\": 1,\n \"loop_uuid\": \"ABCD\",\n \"dealt_status\": 2 \n}\n\nResponse is only http status code 200 if all is ok.
\n","urlObject":{"path":["v1","organizations","{{organization_uuid}}","exports","{{resource}}"],"host":["{{url_api}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"a03009ed-d09c-4ff1-85c1-36684d2c8421"},{"name":"List All Exports From the Track CXM platform","id":"1620c7dd-84ff-49b5-89b3-23a80bd66f2f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{url_api}}/v1/organizations/{{organization_uuid}}/exports/{{resource}}","description":"This endpoint allows listing all data exports performed on the Track CXM platform.
\nGET {{url_api}}/v1/organizations/{{organization_uuid}}/exports
{{organization_uuid}} (String): The unique identifier of the organization.The response will be a JSON containing a list of all data exports performed by the organization.
\n{\n \"data\": {\n \"exports\": [\n {\n \"uuid\": \"...\",\n \"name\": \"...\",\n \"status\": \"...\",\n \"csv_url\": \"...\",\n \"created_at\": \"...\"\n },\n {...} //Exports\n ]\n }\n}\n\nA webhook is an elegant way to be notified whenever there is an event in your surveys on the Track CXM platform. Follow the steps below to configure and receive notifications via POST in your system.
\nAfter correctly configuring the webhook, your system will receive notifications via POST whenever there is an event.
\n{\n \"events\": [\n {\n \"type\": \"...\",\n \"interaction_uuid\": \"...\", // uuid v4\n \"distribution_uuid\": \"...\", // uuid v4\n \"survey_uuid\": \"...\", // uuid v4\n \"survey_name\": \"...\", // string\n \"survey_public_hash\": \"...\", // string\n \"answered_at\": \"...\", // unix timestamp (integer)\n \"distributed_at\": \"...\", // unix timestamp (integer)\n \"answered_channel\": \"...\", // web, widget, sms\n \"distribution_channel\": \"...\", // email, sms, widget, link, linklist, qrcode\n \"health_score\": \"...\", // integer\n \"answers\": [\n {\n \"item_uuid\": \"...\", // uuid v4\n \"question_type\": \"...\", // nps_relational, nps_transactional, ces, ces2, csat, ratings, emoji, thumbs, multiple_choice, open\n \"question\": \"...\", // string\n \"answer\": \"...\", // string or array for multiple_choice (Ex.: [\"answer A\",\"answer B\"])\n \"comment\": \"...\", // string\n \"other_option\": \"...\" // string (outra opção para múltipla escolha)\n },\n {...}\n ],\n \"customer\": {\n \"name\": \"...\", // string\n \"email\": \"...\", // email string\n \"phone\": \"...\", // integer\n \"attributes\": [\n {\n \"uuid\": \"...\", // uuid v4\n \"name\": \"...\", // string\n \"value\": \"...\" // string\n }\n ]\n },\n \"interaction_attributes\": [\n {\n \"uuid\": \"...\", // string\n \"name\": \"...\", // string\n \"value\": \"...\" // string\n }\n ]\n }\n ]\n}\n\nThis endpoint allows you to retrieve and list all distributions for all surveys linked to a specific research group.
\nGET /v1/organizations/{{organization_uuid}}/distributions/survey-groups/{{survey_group_uuid}}?start=2026-03-01&end=2026-03-02&limit=10&page=1
organization_uuid (String): Unique identifier for the organization.
\nsurvey_group_uuid (String): Unique identifier for the research group.
\nstart and end (Required if one is used):
Filters interactions by response date range (up to a 3-month interval).
Format: YYYY-MM-DD
limit (Integer):
Number of records per page (Maximum: 100).
Default: 10
page (Integer):
The page number to be displayed for pagination.
{\n \"data\": {\n \"distribution\": [\n {\n \"uuid\": \"0b1caa77-0f6e-4b9e-9637-faa3cf6dbd6c\",\n \"distribution_name\": \"Anônima 3/12/2026, 5:11:05 PM\",\n \"distribution_chanel\": 6,\n \"survey_uuid\": \"33b2ba35-d466-4eea-95e5-0b5ecdf47f4d\",\n \"survey_name\": \"xxxx\",\n \"schedule_at\": null,\n \"validity_at\": null,\n \"reminder_at\": null,\n \"counter\": 1,\n \"distributed_at\": 0,\n \"added\": 0,\n \"valid\": 0,\n \"processed\": 0,\n \"delivered\": 0,\n \"opened\": 0,\n \"clicked\": 0,\n \"answered\": 0,\n \"done\": 0,\n \"partial\": 0,\n \"failed\": 0,\n \"invalid\": 0,\n \"not_delivered\": 0,\n \"invalid_errors\": {\n \"error_channel_attribute_format_counter\": 0,\n \"error_duplicated_channel_counter\": 0,\n \"error_duplicated_customer_counter\": 0,\n \"error_identifier_format_counter\": 0,\n \"error_no_channel_counter\": 0,\n \"error_no_customer_counter\": 0,\n \"error_parse_counter\": 0,\n \"error_unknown_channel_counter\": 0\n },\n \"not_delivered_errors\": {\n \"error_blocked_counter\": 0,\n \"error_blockrule_counter\": 0,\n \"error_quarantine_counter\": 0,\n \"error_unsubscribed_channel_counter\": 0\n },\n \"error_response_counter\": 0,\n \"sender_type\": 0,\n \"survey_hash\": \"xxxx\",\n \"distribution_hash\": \"xxxx\",\n \"organization_hash\": \"xxxx\",\n \"created_at\": 1773346281\n }\n ],\n \"total\": 1,\n \"pages\": 1,\n \"current_page\": 1,\n \"per_page\": 100\n },\n \"success\": 1,\n \"message\": \"\",\n \"cache_timestamp\": 0\n}\n\nData de ínicio (obrigatório se tiver end)
\n","type":"text/plain"},"key":"start","value":"2026-03-01"},{"disabled":true,"description":{"content":"Data de fim (obrigatório se tiver start)
\n","type":"text/plain"},"key":"end","value":"2026-03-02"},{"disabled":true,"description":{"content":"Quantidade de itens por página (opcional)
\n","type":"text/plain"},"key":"limit","value":"10"},{"disabled":true,"description":{"content":"Número da página (opcional)
\n","type":"text/plain"},"key":"page","value":"1"}],"variable":[]}},"response":[],"_postman_id":"91264f5e-3f29-49a5-ae54-ba842da5b999"}],"id":"e90ca531-481a-45e4-92fc-c521b008a1a1","description":"Your gateway to a comprehensive and personalized integration
\nTrack CXM provides its customers with a robust API, enabling seamless integration of our platform with various other systems. Through the Track CXM API, you gain access to a universe of functionalities that facilitate data collection, processing, and analysis, driving customer experience in your company.
\nCustom-tailored survey distribution and data extraction
\nWith the Track CXM API, you have the power to:
\nStrategically distribute stored Track CXM surveys: Create and distribute personalized surveys to different audiences, collecting valuable feedback and actionable insights that boost customer satisfaction.
\nAccurately extract stored Track CXM data: Access and extract relevant data in an automated manner, enriching your knowledge base and optimizing internal processes.
\nPerform personalized actions for your organization based on data stored in Track CXM: Automate tasks and workflows based on the collected data, streamlining problem resolution and enhancing the customer experience.
\nTailored integration for your needs
\nThe Track CXM API is designed to offer total flexibility, allowing you to customize the integration according to the specific needs of your business. Whatever your scenario, Track CXM offers the ideal solution to seamlessly integrate with your technological infrastructure.
\nExplore more Track CXM integration features
\nTrack CXM goes beyond the API, offering several other integration options to meet your needs:
\nWebhook integration on Track CXM: Receive real-time notifications about important events on the Track CXM platform.
\nSFTP integration on Track CXM: Securely and automatically transfer data between Track CXM and your systems.
\nWidget integration on Track CXM: Integrate Track CXM directly into your website or application, collecting instant feedback from your customers.
\nAccess the Track CXM Help Center for more information
\nTo learn more about Track CXM API features, ask questions about the platform, or explore other integration options, access our comprehensive and detailed Help Center. Our team of experts is always available to assist you at every step of your integration journey.
\nRemember:
\nBefore starting the integration with Track CXM, it is essential to read all the documentation carefully. The CXM API endpoints are organized in a linear and complementary way, ensuring a complete and efficient integration.
\nWith the Track CXM API, you have everything you need to transform the customer experience in your company. Start integrating Track CXM today and enjoy the benefits of a complete and versatile platform.
\nEnsuring secure and personalized access to the Track CXM API
\nTo ensure a secure and personalized integration with the Track CXM API, it is necessary to use a unique authentication token and your organization's identifier. This data acts as access keys that allow the Track CXM API to identify and validate your request, ensuring that only authorized users can access the platform's resources.
\nObtaining your Track CXM API authentication credentials:
\nAccess your dashboard on the Track CXM Plataform: Start the authentication process by accessing the Track CXM control panel with your usual login credentials.
\nWithin the Track CXM platform, navigate to Settings > Integrations > API: In the main panel menu, locate the \"Settings\" section and then click on \"Integrations\". Within the integrations area, select the \"API\" option.
\nActivate Track CXM API integration: To enable the use of the Track CXM API, click on the \"Activate API\" button. This action will allow you to generate the authentication token and organization identifier required for the integration.
\nRetrieve your TOKEN and organization UUID stored on the Track CXM platform: After activating the Track CXM API, you will have access to your unique authentication token and organization identifier (UUID). Store this information securely, as it will be essential for making requests to the Track CXM API.
\nImportant notes:
\nSecurity first for Track CXM API access: The authentication token and organization identifier are confidential information. Keep them in a safe place and avoid sharing them with third parties.
\nTrack CXM support at your fingertips: If you have any questions or difficulties during the process of obtaining authentication credentials, please contact our Track CXM technical support team. We are always available to assist you and ensure a smooth and efficient integration experience.
\nWith the authentication token and organization identifier in hand, you will be ready to enjoy all the features of the Track CXM API and perform personalized integrations that will boost the customer experience in your company.
\nOur API calls are limited to 2.000 requests per minute. Integration should adjust to this limit to prevent requests from returning error.
\nAuthorization
\nIn all requests to the Track CXM API, it will be necessary to inform a Bearer token in the request header:
Authorization: Bearer {{token_here}}\n\nAll Track CXM API responses follow the JSON standard. This is also the standard in which
\nsend on header: Content-Type:application/json
All requests to the Track CXM API should be made to:
\nhttps://api.track.co\n\nThis is the standard URL for all API endpoints, ensuring a consistent and streamlined integration experience.
\nWhenever the HTTP status code returned by the Track CXM API is different from 200, the server will respond with the following error pattern:
\n{\n \"message\": \"\",\n \"success\": \"\"\n}\n\n