Pesquisas

Endpoints para consulta de pesquisas disponíveis.

Listar Pesquisas

GET /api/searches

Retorna a lista de pesquisas vinculadas ao token do usuário.

Casos de uso:

Obter IDs de pesquisas para integração
Popular seletores de pesquisa
Validar pesquisas disponíveis para disparo

Exemplo de Requisição

bash

curl -X GET "https://api-b2s.experienciab2s.com/api/searches" \
     -H "Authorization: Bearer SEU_TOKEN"

Resposta de Sucesso (200)

json

[
  {
    "id": "103a525c-0ce3-4182-a504-aad595425233",
    "name": "Pesquisa de Satisfação - Restaurante",
    "company_id": "603a525c-0ce3-4182-a504-aad595425233"
  },
  {
    "id": "203a525c-0ce3-4182-a504-aad595425233",
    "name": "Pesquisa de Satisfação - Delivery",
    "company_id": "503a525c-0ce3-4182-a504-aad595425233"
  }
]

Estrutura da Resposta

Campo	Tipo	Descrição
`id`	string	ID único da pesquisa (UUID)
`name`	string	Nome da pesquisa
`company_id`	string	ID da empresa vinculada (UUID)

Códigos de Resposta

Código	Descrição
200	Pesquisas encontradas
401	Token ausente ou inválido
403	Token inválido ou usuário não autorizado
404	Token de integração não encontrado

Obter Pesquisa com Questões

GET /api/searches/:id

Retorna os detalhes completos de uma pesquisa, incluindo todas as questões com suporte a múltiplos idiomas. A estrutura da resposta varia conforme o valor de has_page:

has_page: false: As questões são retornadas diretamente no campo questions
has_page: true: As questões são organizadas dentro de páginas no campo pages

Casos de uso:

Renderizar formulário de pesquisa customizado
Obter estrutura completa de questões para integração
Carregar traduções das questões para sistemas multilíngue
Validar tipos e formatos de questões antes do envio

Parâmetros de URL

Parâmetro	Tipo	Obrigatório	Descrição
`id`	string	Sim	ID único da pesquisa (UUID)

Exemplo de Requisição

bash

curl -X GET "https://api-b2s.experienciab2s.com/api/searches/103a525c-0ce3-4182-a504-aad595425233" \
     -H "Authorization: Bearer SEU_TOKEN"

Resposta de Sucesso (200) - Sem Páginas

Quando has_page é false, as questões são retornadas diretamente:

json

{
  "has_page": false,
  "translations": [
    {
      "language_code": "pt-BR",
      "nps": "Como você avalia sua experiência?",
      "discursive_question": "Deixe seu comentário",
      "question_page": "Em qual salão você se encontra?"
    },
    {
      "language_code": "en-US",
      "nps": "How do you rate your experience?",
      "discursive_question": "Leave your comment",
      "question_page": "Which salon are you at?"
    }
  ],
  "questions": [
    {
      "id": "q1-uuid-example",
      "required": true,
      "others": false,
      "unknown": false,
      "type": "Resposta curta",
      "format": "default",
      "options": [],
      "translations": [
        {
          "language_code": "pt-BR",
          "name": "Qual seu nome completo?",
          "description": "Informe seu nome para identificação"
        },
        {
          "language_code": "en-US",
          "name": "What is your full name?",
          "description": "Enter your name for identification"
        }
      ]
    },
    {
      "id": "q2-uuid-example",
      "required": false,
      "others": false,
      "unknown": false,
      "type": "Rating",
      "format": "default",
      "options": [
        {
          "id": "opt1-uuid",
          "translations": [
            {
              "language_code": "pt-BR",
              "name": "Excelente"
            },
            {
              "language_code": "en-US",
              "name": "Excellent"
            }
          ]
        },
        {
          "id": "opt2-uuid",
          "translations": [
            {
              "language_code": "pt-BR",
              "name": "Bom"
            },
            {
              "language_code": "en-US",
              "name": "Good"
            }
          ]
        }
      ],
      "translations": [
        {
          "language_code": "pt-BR",
          "name": "Como você avalia o atendimento?",
          "description": "Avalie a qualidade do atendimento recebido",
          "detractor_replica": "Lamentamos pela sua experiência",
          "neutral_replica": "Obrigado pelo feedback",
          "promoter_replica": "Ficamos felizes com sua avaliação!"
        },
        {
          "language_code": "en-US",
          "name": "How do you rate the service?",
          "description": "Rate the quality of the service received",
          "detractor_replica": "We're sorry for your experience",
          "neutral_replica": "Thank you for your feedback",
          "promoter_replica": "We're happy with your rating!"
        }
      ]
    }
  ]
}

Resposta de Sucesso (200) - Com Páginas

Quando has_page é true, as questões são organizadas em páginas:

json

{
  "has_page": true,
  "translations": [
    {
      "language_code": "pt-BR",
      "nps": "Como você avalia sua experiência?",
      "discursive_question": "Deixe seu comentário",
      "question_page": "Em qual salão você se encontra?"
    },
    {
      "language_code": "en-US",
      "nps": "How do you rate your experience?",
      "discursive_question": "Leave your comment",
      "question_page": "Which salon are you at?"
    }
  ],
  "pages": [
    {
      "id": "page1-uuid-example",
      "translations": [
        {
          "language_code": "pt-BR",
          "name": "Dados Pessoais"
        },
        {
          "language_code": "en-US",
          "name": "Personal Data"
        }
      ],
      "questions": [
        {
          "id": "q1-uuid-example",
          "required": true,
          "others": false,
          "unknown": false,
          "type": "Resposta curta",
          "format": "default",
          "options": [],
          "translations": [
            {
              "language_code": "pt-BR",
              "name": "Qual seu nome completo?",
              "description": "Informe seu nome para identificação"
            },
            {
              "language_code": "en-US",
              "name": "What is your full name?",
              "description": "Enter your name for identification"
            }
          ]
        }
      ]
    },
    {
      "id": "page2-uuid-example",
      "translations": [
        {
          "language_code": "pt-BR",
          "name": "Avaliação do Atendimento"
        },
        {
          "language_code": "en-US",
          "name": "Service Evaluation"
        }
      ],
      "questions": [
        {
          "id": "q2-uuid-example",
          "required": true,
          "others": false,
          "unknown": false,
          "type": "Rating",
          "format": "default",
          "options": [
            {
              "id": "opt1-uuid",
              "translations": [
                {
                  "language_code": "pt-BR",
                  "name": "Excelente"
                },
                {
                  "language_code": "en-US",
                  "name": "Excellent"
                }
              ]
            },
            {
              "id": "opt2-uuid",
              "translations": [
                {
                  "language_code": "pt-BR",
                  "name": "Bom"
                },
                {
                  "language_code": "en-US",
                  "name": "Good"
                }
              ]
            }
          ],
          "translations": [
            {
              "language_code": "pt-BR",
              "name": "Como você avalia o atendimento?",
              "description": "Avalie a qualidade do atendimento recebido",
              "detractor_replica": "Lamentamos pela sua experiência",
              "neutral_replica": "Obrigado pelo feedback",
              "promoter_replica": "Ficamos felizes com sua avaliação!"
            },
            {
              "language_code": "en-US",
              "name": "How do you rate the service?",
              "description": "Rate the quality of the service received",
              "detractor_replica": "We're sorry for your experience",
              "neutral_replica": "Thank you for your feedback",
              "promoter_replica": "We're happy with your rating!"
            }
          ]
        }
      ]
    }
  ]
}

Estrutura da Resposta

Campo	Tipo	Descrição
`has_page`	boolean	Indica se a pesquisa possui múltiplas páginas
`translations`	array	Traduções dos textos principais da pesquisa
`questions`	array	Lista de questões (apenas quando `has_page: false`)
`pages`	array	Lista de páginas com questões (apenas quando `has_page: true`)

Objeto `translations` (da pesquisa)

Campo	Tipo	Descrição
`language_code`	string	Código do idioma (ex: "pt-BR", "en-US", "es-ES")
`nps`	string	Texto da pergunta NPS principal
`discursive_question`	string	Texto da pergunta discursiva/comentário
`question_page`	string	Texto da pergunta para seleção de página

Estrutura de Page

Campo	Tipo	Descrição
`id`	string	ID único da página (UUID)
`translations`	array	Traduções do nome da página
`questions`	array	Lista de questões da página

Objeto `translations` (da página)

Campo	Tipo	Descrição
`language_code`	string	Código do idioma (ex: "pt-BR", "en-US")
`name`	string	Nome/título da página

Estrutura de Question

Campo	Tipo	Descrição
`id`	string	ID único da questão (UUID)
`required`	boolean	Se a questão é obrigatória
`others`	boolean	Se permite opção "Outros"
`unknown`	boolean	Se permite opção "Não sei/Desconhecido"
`type`	string	Tipo da questão (ver tabela abaixo)
`format`	string	Formato de exibição (ver tabela abaixo)
`options`	array	Opções de resposta disponíveis
`translations`	array	Traduções da questão em diferentes idiomas

Tipos de Questão (type)

Tipo	Descrição
`Atendente`	Seleção de atendente/funcionário
`Caixa de seleção`	Múltipla escolha com checkboxes
`CSAT`	Customer Satisfaction Score (1-5)
`Data`	Campo de seleção de data
`Emoticon`	Avaliação por emoticons/emojis
`Like/Dislike`	Avaliação binária (gostei/não gostei)
`Multipla escolha`	Seleção entre múltiplas opções
`NPS`	Net Promoter Score (0-10)
`Rating`	Avaliação por estrelas/nota
`Resposta curta`	Campo de texto livre

Formatos de Exibição (format)

Formato	Descrição	Disponível em
`default`	Exibição padrão (botões/cards)	Todos os tipos
`select`	Menu suspenso (dropdown)	Atendente, Múltipla escolha
`checkbox`	Caixa de seleção múltipla	Atendente

Objeto `translations` (da questão)

Campo	Tipo	Descrição
`language_code`	string	Código do idioma (ex: "pt-BR", "en-US")
`name`	string	Texto traduzido da questão
`description`	string	Descrição traduzida (opcional)
`promoter_replica`	string	Resposta para notas altas (opcional)
`neutral_replica`	string	Resposta para notas médias (opcional)
`detractor_replica`	string	Resposta para notas baixas (opcional)
`criteria`	string	Critério traduzido (opcional)

Estrutura de Option

Campo	Tipo	Descrição
`id`	string	ID único da opção (UUID)
`translations`	array	Traduções da opção em outros idiomas

Objeto `translations` (da opção)

Campo	Tipo	Descrição
`language_code`	string	Código do idioma (ex: "pt-BR", "en-US")
`name`	string	Texto traduzido da opção

Códigos de Resposta

Código	Descrição
200	Pesquisa encontrada com sucesso
401	Token ausente ou inválido
403	Token inválido ou usuário não autorizado
404	Pesquisa não encontrada

Fluxo Recomendado para Integração

Buscar pesquisa: GET /api/searches/:id
Selecionar idioma: Filtrar traduções pelo language_code desejado
Verificar has_page:
- Se false: Iterar diretamente sobre questions
- Se true: Exibir seleção de página e iterar sobre pages[].questions
Renderizar questões: Usar translations para exibir no idioma correto

Pesquisas ​

Listar Pesquisas ​

Exemplo de Requisição ​

Resposta de Sucesso (200) ​

Estrutura da Resposta ​

Códigos de Resposta ​

Obter Pesquisa com Questões ​

Parâmetros de URL ​

Exemplo de Requisição ​

Resposta de Sucesso (200) - Sem Páginas ​

Resposta de Sucesso (200) - Com Páginas ​

Estrutura da Resposta ​

Objeto translations (da pesquisa) ​

Estrutura de Page ​

Objeto translations (da página) ​

Estrutura de Question ​

Tipos de Questão (type) ​

Formatos de Exibição (format) ​

Objeto translations (da questão) ​

Estrutura de Option ​

Objeto translations (da opção) ​

Códigos de Resposta ​

Fluxo Recomendado para Integração ​

Pesquisas

Listar Pesquisas

Exemplo de Requisição

Resposta de Sucesso (200)

Estrutura da Resposta

Códigos de Resposta

Obter Pesquisa com Questões

Parâmetros de URL

Exemplo de Requisição

Resposta de Sucesso (200) - Sem Páginas

Resposta de Sucesso (200) - Com Páginas

Estrutura da Resposta

Objeto `translations` (da pesquisa)

Estrutura de Page

Objeto `translations` (da página)

Estrutura de Question

Tipos de Questão (type)

Formatos de Exibição (format)

Objeto `translations` (da questão)

Estrutura de Option

Objeto `translations` (da opção)

Códigos de Resposta

Fluxo Recomendado para Integração