Guias Práticos

Fluxo de integração - API de consulta de Feedbacks

Este endpoint permite a consulta dos feedbacks dos instrumentos.

Suggest Edits

Acesse o endpoint Consulta dos feedbacks dos instrumentos para consultar os feedbacks dados em um instrumento dentro de um período específico.

Parâmetros da requisição

Nome do campoDescriçãoObrigatório/regra de negócio
instrumentUID do instrumentoObrigatório. O UID do instrumento pode ser encontrado na área de administração de instrumentos no endereço da página de edição do instrumento.
startDateData de início do filtro (formato YYYY-MM-DD)Obrigatório.
endDateData final do filtro (formato YYYY-MM-DD)Obrigatório.
leadersQuando enviado, filtraremos os comentários de acordo com os valores inseridos naquele atributo. Para envio, deve-se considerar o id do atributo.Não
groupsQuando enviado, filtraremos os comentários de acordo com os valores inseridos naquele atributo. Para envio, deve-se considerar o id do atributo.Não
positionsQuando enviado, filtraremos os comentários de acordo com os valores inseridos naquele atributo. Para envio, deve-se considerar o nome do atributo.Não
gendersQuando enviado, filtraremos os comentários de acordo com os valores inseridos naquele atributo. Para envio, deve-se considerar o nome do atributo.Não
sexesQuando enviado, filtraremos os comentários de acordo com os valores inseridos naquele atributo. Para envio, deve-se considerar "F" para Feminino e "M" para Masculino.Não
unitBusinessesQuando enviado, filtraremos os comentários de acordo com os valores inseridos naquele atributo. Para envio, deve-se considerar o nome do atributo.Não
unitGeographiesQuando enviado, filtraremos os comentários de acordo com os valores inseridos naquele atributo. Para envio, deve-se considerar o nome do atributo.Não
tagsQuando enviado, filtraremos os comentários de acordo com os valores inseridos naquele atributo. Para envio, deve-se considerar o nome do atributo.Não
scholaritiesQuando enviado, filtraremos os comentários de acordo com os valores inseridos naquele atributo. Para envio, deve-se considerar o nome do atributo.Não

📘

ATENÇÃO

O uid_instrument pode ser obtido através da requisição para obter todos os instrumentos

Exemplo de requisição:

curl --location 'https://www.pulses.com.br/api/engage/v1/instruments/[uid_instrument]' \
--header 'Authorization: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--header 'Cookie: PHPSESSID=746h8innd3jk81itjvqfi63tbv' \
--data-urlencode 'instrument=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX' \
--data-urlencode 'startDate=2025-01-01' \
--data-urlencode 'endDate=2025-05-14' \
--data-urlencode 'sexes%5B0%5D=M'

Exemplo de response:

[
    {
        "Recebido em": //DATA DE RECEBIMENTO (formato: DD/MM/YYY),
        "Dimensão": //NOME DA DIMENSÃO,
        "Pergunta do Fator": //TEXTO DA PERGUNTA,
        "Pergunta do Feedback": //TEXTO DA PERGUNTA DE FEEDBACK,
        "Nota": //NOTA VINCULADA À PERGUNTA QUE GEROU FEEDBACK,
        "Feedback": //TEXTO DO FEEDBACK RECEBIDO,
        "Enviado por": //NOME DE QUEM ENVIOU O FEEDBACK,
        "Lido": //VISUALIZADO PELO ADMINISTRADOR,
        "Resposta": //ÚLTIMA RESPOSTA ENVIADA,
        "Respondido por": //NOME DE QUEM RESPONDEU,
        "Respondido em": //DATA DE RESPOSTA (formato: DD/MM/YYY)
    }
]

❗️

ATENÇÃO

Os feedbacks estão disponíveis para alguns instrumentos. NPS, e-NPS e engajamento não possuem feedbacks.

Updated 21 days ago