Avaliações e Reputação
O serviço de Avaliações e Reputação retorna informações sobre a reputação da empresa em diversas plataformas de avaliação, incluindo histórico e visão consolidada.
Quando usar
Descrição
O serviço de Avaliações e Reputação oferece dados detalhados sobre a reputação da empresa em diferentes plataformas e sites de avaliação, apresentando a evolução histórica e uma visão consolidada das avaliações.
Essas informações são úteis para verificar a existência real da empresa, analisar riscos e alimentar modelos estatísticos.
Requisição
Autenticação por chave de API (cabeçalho Authorization: Bearer), criada no painel com esta consulta no escopo.
POST /api/v1/{tenant}/empresas/avaliacoes-e-reputacao
| Campo | Obrigatório | Descrição |
|---|---|---|
document |
sim | CNPJ da empresa, com ou sem máscara. |
{
"document": "00.000.000/0000-00"
}
Campos de retorno
Campos dentro de data. [] indica lista.
| Campo | Tipo |
|---|---|
TotalReviews |
número |
TotalReviewsLast30Days |
número |
TotalReviewsLast90Days |
número |
TotalReviewsLast180Days |
número |
TotalReviewsLast365Days |
número |
TotalSourcesWithReviews |
número |
TotalSourcesWithReviewsLast30Days |
número |
TotalSourcesWithReviewsLast90Days |
número |
TotalSourcesWithReviewsLast180Days |
número |
TotalSourcesWithReviewsLast365Days |
número |
FirstReviewDate |
data |
LastReviewDate |
data |
MaxReputationRatingByDataSources |
número |
MaxReputationRatingDescriptionByDataSources |
texto |
MinReputationRatingByDataSources |
texto |
MinReputationRatingDescriptionByDataSources |
texto |
ReputationSummaryByDataSources.<chave> |
texto |
LastUpdateDate |
data |
ReputationInfo[].Name |
texto |
ReputationInfo[].Description |
texto |
ReputationInfo[].Categories |
texto |
ReputationInfo[].DataSource |
texto |
ReputationInfo[].ScoreBySource |
número |
ReputationInfo[].ScoreBySourceDescription |
texto |
ReputationInfo[].ScoreByConsumer |
texto |
ReputationInfo[].ScoreByConsumeDescription |
texto |
ReputationInfo[].ReviewsNumber |
número |
ReputationInfo[].TotalAnswered |
número |
ReputationInfo[].TotalUnanswered |
número |
ReputationInfo[].TotalEvaluated |
número |
ReputationInfo[].TotalUnevaluated |
número |
ReputationInfo[].AnsweredPercentage |
texto |
ReputationInfo[].UnansweredPercentage |
texto |
ReputationInfo[].EvaluatedPercentage |
texto |
ReputationInfo[].UnevaluatedPercentage |
texto |
ReputationInfo[].WouldDoBusinessAgainPercentage |
texto |
ReputationInfo[].SolvedPercentage |
texto |
ReputationInfo[].UnsolvedPercentage |
texto |
ReputationInfo[].AverageAnswerTimeInHours |
texto |
ReputationInfo[].ReviewsDetailedDescription[].Review.Aplicativos |
número |
ReputationInfo[].ReviewsDetailedDescription[].Review.Login-Senha |
número |
ReputationInfo[].ReviewsDetailedDescription[].Review.<chave> |
número |
ReputationInfo[].ReviewsDetailedDescription[].Review.Aparelhos |
número |
ReputationInfo[].ReviewsDetailedDescription[].Review.Embalagens |
número |
ReputationInfo[].ReviewsDetailedDescription[].ReviewDate |
data |
<chave> |
número |
Exemplo de resposta
Estrutura real da resposta, com valores fictícios.
{
"execution_id": "00000000-0000-0000-0000-000000000000",
"status": "success",
"message": "Consulta realizada com sucesso",
"query_name": "Avaliações e Reputação",
"query_slug": "avaliacoes-e-reputacao",
"data": {
"TotalReviews": 0,
"TotalReviewsLast30Days": 0,
"TotalReviewsLast90Days": 0,
"TotalReviewsLast180Days": 0,
"TotalReviewsLast365Days": 0,
"TotalSourcesWithReviews": 0,
"TotalSourcesWithReviewsLast30Days": 0,
"TotalSourcesWithReviewsLast90Days": 0,
"TotalSourcesWithReviewsLast180Days": 0,
"TotalSourcesWithReviewsLast365Days": 0,
"FirstReviewDate": "2026-01-01",
"LastReviewDate": "2026-01-01",
"MaxReputationRatingByDataSources": 0,
"MaxReputationRatingDescriptionByDataSources": "texto",
"MinReputationRatingByDataSources": "texto",
"MinReputationRatingDescriptionByDataSources": "texto",
"ReputationSummaryByDataSources": {
"<chave>": "texto"
},
"LastUpdateDate": "2026-01-01",
"ReputationInfo": [
{
"Name": "texto",
"Description": "texto",
"Categories": "texto",
"DataSource": "texto",
"ScoreBySource": 0,
"ScoreBySourceDescription": "texto",
"ScoreByConsumer": "texto",
"ScoreByConsumeDescription": "texto",
"ReviewsNumber": 0,
"TotalAnswered": 0,
"TotalUnanswered": 0,
"TotalEvaluated": 0,
"TotalUnevaluated": 0,
"AnsweredPercentage": "texto",
"UnansweredPercentage": "texto",
"EvaluatedPercentage": "texto",
"UnevaluatedPercentage": "texto",
"WouldDoBusinessAgainPercentage": "texto",
"SolvedPercentage": "texto",
"UnsolvedPercentage": "texto",
"AverageAnswerTimeInHours": "texto",
"ReviewsDetailedDescription": [
{
"Review": {
"Aplicativos": 0,
"Login-Senha": 0,
"<chave>": 0,
"Aparelhos": 0,
"Embalagens": 0
},
"ReviewDate": "2026-01-01"
}
]
}
],
"<chave>": 0
},
"consulted_at": "2026-01-01T12:00:00Z",
"query_cost": "0.560"
}
Cobrança e respostas
- O valor é cobrado por consulta bem-sucedida.
- 200 — consulta processada (veja status no corpo da resposta)
- 401 — token ausente, inválido, inativo ou expirado
- 403 — serviço fora do escopo da chave, IP não autorizado ou limite de consumo excedido
- 422 — campo obrigatório ausente/inválido ou payload acima do limite do serviço
- 429 — limite de requisições por minuto da chave excedido
- 504 — tempo máximo de execução do serviço excedido