Fluxo de Integração - API de Consulta Pública da Caixa de Sugestões com Filtros

❗️
ATENÇÃO
Para utilizar esta API, o admin da conta deverá preencher o formulário no site https://suporte.gupy.io/s/suporte/ solicitando o token da API do mapa de calor.

Parâmetros da requisição

Nome do campo	Descrição	Obrigatório/regra de negócio
startDate	Data inicial do período de consulta.	Não
endDate	Data final do período de consulta. Se não for informada, será considerada a data atual. O formato deve ser YYYY-MM-DD.	Não.
offset	A partir de qual sugestão deve-se pegar	Não.
limit	Quantidade de sugestões máxima para retorno por página. Se não for informada, será considerada como 15.	Não
unread	Quando for "true", retornará só as sugestões não lidas. Quando for "false", só as lidas. Quando não for informado, retornará lidas e não lidas.	Não
leaders	Quando enviado, filtraremos os comentários de acordo com os valores inseridos naquele atributo. Para envio, deve-se considerar o id do atributo.	Não
groups	Quando enviado, filtraremos os comentários de acordo com os valores inseridos naquele atributo. Para envio, deve-se considerar o id do atributo.	Não
positions	Quando enviado, filtraremos os comentários de acordo com os valores inseridos naquele atributo. Para envio, deve-se considerar o nome do atributo.	Não
genders	Quando enviado, filtraremos os comentários de acordo com os valores inseridos naquele atributo. Para envio, deve-se considerar o nome do atributo.	Não
sexes	Quando 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
unitBusinesses	Quando enviado, filtraremos os comentários de acordo com os valores inseridos naquele atributo. Para envio, deve-se considerar o nome do atributo.	Não
unitGeographies	Quando enviado, filtraremos os comentários de acordo com os valores inseridos naquele atributo. Para envio, deve-se considerar o nome do atributo.	Não
tags	Quando enviado, filtraremos os comentários de acordo com os valores inseridos naquele atributo. Para envio, deve-se considerar o nome do atributo.	Não
scholarities	Quando enviado, filtraremos os comentários de acordo com os valores inseridos naquele atributo. Para envio, deve-se considerar o nome do atributo.	Não

Exemplo de requisição:

curl --request POST \
     --url https://www.pulses.com.br/api/engage/v1/suggestions/search \
     --header 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
     --header 'accept: application/json' \
     --header 'content-type: application/json'

curl --request POST \
     --url https://www.pulses.com.br/api/engage/v1/suggestions/search \
     --header 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "endDate": "2025-05-13",
  "startDate": "2025-05-13",
  "leaders": [34243]
}
'

Exemplo de response:

Esta chamada retorna um objeto com a seguinte estrutura:

{
  "suggestions": [
    {
      "id": string,
      "description": string,
      "timestamp": string,
      "unread": string,
      "subject": object,
      "respondent": string,
      "answer": string,
      "answeredAt": string
    }
  ],
  "code": number [0/1],
  "page": {
    "actualPage": number,
    "limit": number
  }
}