Fluxo de integração - API de consulta de Suggestion Box

Acesse o endpoint Consulta das sugestões enviadas pelo suggestion box para consultar os suggestion box enviados dentro de um período específico.

Parâmetros da requisição

Nome do campo	Descrição	Obrigatório/regra de negócio
from_date	Data de início do filtro (formato YYYY-MM-DD)	Obrigatório.
to_date	Data final do filtro (formato YYYY-MM-DD)	Obrigatório.
page	Página que quer visualizar as sugestões (default: 1)	Não obrigatório.
offset	Primeiro comentário a ser visualizado (default: 1)	Não obrigatório.
limit	Limite de comentários por página (default: 5000)	Não obrigatório.

Exemplo de requisição:

curl --location 'https://www.pulses.com.br/api/engage/v1/suggestions/?from_date%09=YYYY-MM-DD&to_date=YYYY-MM-DD&page=1&offset=1&limit=5000' \
--header 'Authorization: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--header 'Cookie: PHPSESSID=deajbemtgam3m5o9p3g4k449uh' \
--data ''

Exemplo de response:

[
        {
            "suggestion": "Sugestão 1",
            "readed": 0,
            "date_received": "2023-03-22 17:12:19",
            "id_client": 0123,
            "name": null,
            "description": "{\"en-US\": \"\", \"es-ES\": \"\", \"pt-BR\": \"Bem-estar\"}"
        },
        {
            "suggestion": "Sugestão 2",
            "readed": 0,
            "date_received": "2023-03-22 17:12:19",
            "id_client": 0123,
            "name": null,
            "description": "{\"en-US\": \"\", \"es-ES\": \"\", \"pt-BR\": \"Bem-estar\"}"
        },
        {
            "suggestion": "Sugestão 3",
            "readed": 0,
            "date_received": "2023-03-22 17:12:19",
            "id_client": 0123,
            "name": null,
            "description": "{\"en-US\": \"\", \"es-ES\": \"\", \"pt-BR\": \"Bem-estar\"}"
        },
        {
            "suggestion": "Sugestão 4",
            "readed": 0,
            "date_received": "2023-03-22 17:12:19",
            "id_client": 0123,
            "name": null,
            "description": "{\"en-US\": \"\", \"es-ES\": \"\", \"pt-BR\": \"Bem-estar\"}"
        }
    ],
    "total": 4,
    "paging": {
        "page": "1",
        "itensPerPage": "5000",
        "previous": "",
        "next": ""
    }

Parâmetros do response

Nome do campo	Descrição
suggestion	Descrição da sugestão enviada
readed	Lido (0: Não, 1: Sim)
date_received	Data que a sugestão foi recebida
id_client	id_client é o identificador interno do cliente dentro da plataforma
name	Nome de quem enviou a sugestão. Caso tenha sido de forma anônima, o valor será "null"
description	Dimensão relacionada a sugestão enviada

Entendendo a paginação:

Ao final de toda a listagem das sugestões enviadas no período selecionado, será apresentado as seguintes informações:

"total": 4,
"paging": {
    "page": "1",
    "itensPerPage": 5000,
    "previous": "",
    "next": ""

Por padrão, a limitação é de 5000 sugestões por página, e caso a conta possua mais de 5000 sugestões a API irá retornar as informações de paginação, contendo a URL para a próxima página.

Utilizando nosso exemplo, considerando uma conta que possui apenas 4 comentários, iremos alterar o limite de comentários por página para 2.

curl --location 'https://www.pulses.com.br/api/engage/v1/suggestions/?page=1&from_date=YYYY-MM-DD&to_date=YYYY-MM-DD&offset=1&limit=2' \
--header 'Authorization: c74991ee37510f832268af7fbc73bc18' \
--header 'Cookie: PHPSESSID=deajbemtgam3m5o9p3g4k449uh' \
--data ''

Para este caso, o retorno da requisição será conforme abaixo, entregando a URL a ser enviada para acessar a próxima página contendo 2 sugestões:

[
        {
            "suggestion": "Sugestão 1",
            "readed": 0,
            "date_received": "2023-03-22 17:12:19",
            "id_client": 0123,
            "name": null,
            "description": "{\"en-US\": \"\", \"es-ES\": \"\", \"pt-BR\": \"Bem-estar\"}"
        },
        {
            "suggestion": "Sugestão 2",
            "readed": 0,
            "date_received": "2023-03-22 17:12:19",
            "id_client": 0123,
            "name": null,
            "description": "{\"en-US\": \"\", \"es-ES\": \"\", \"pt-BR\": \"Bem-estar\"}"
        }
    ],
    "total": 4,
    "paging": {
        "page": "1",
        "itensPerPage": "2",
        "previous": "",
        "next": "https://www.pulses.com.br/api/engage/v1/suggestions/?page=2&from_date=2023-03-22&to_date=2023-03-23&limit=2"
    }