APIs › Extras › API Listar Avaliações

API Listar Avaliações

Todas

Listar as respostas das pesquisas de satisfação, com as estatísticas do período.

API: Todas

Endpoint

https://apichat.agpt.com.br/api/ratings?dateStart=2026-09-01&dateEnd=2026-09-30&pageNumber=1&pageSize=20

Método

GET

Autenticação

Bearer {seutokenaqui}

Payload

// sem payload — os filtros vão na própria URL

Esta chamada não tem payload. Os filtros são informados como query na URL, por exemplo ?dateStart=2026-09-01&userId=31.

“dateStart” e “dateEnd”: período, no formato AAAA-MM-DD, incluindo o dia inteiro.

“searchParam”: busca por nome ou número do contato, ou por nome do operador.

“ratingId”: só as respostas de um modelo de pesquisa.

“userId”: só as respostas dos atendimentos de um operador.

“queueId”: só as respostas dos atendimentos de um Setor.

“pageNumber” e “pageSize”: página e quantos itens por página. Padrão 1 e 20; o teto é 200.

Cada resposta vem com a nota, a opção marcada, o atendimento com o contato e o Setor, o operador e o modelo de pesquisa.

A lista vem das mais recentes para as mais antigas, e acompanha as estatísticas do recorte: total, média das notas e quantas respostas por opção.

Utilize o código em requisições HTTPS com ferramentas como cURL ou bibliotecas de integração.

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://apichat.agpt.com.br/api/ratings?dateStart=2026-09-01&dateEnd=2026-09-30&pageNumber=1&pageSize=20',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json',
    'Authorization: Bearer {seutokenaqui}' //Token cadastrado na conexão
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;