Avaliações

Endpoints para consulta externa do sumário de avaliações de reputação do Google Reviews, iFood Reviews e Trip Reviews.

Base URL das rotas: /api/reviews

Autenticação obrigatória em todas as rotas:

bash

Authorization: Bearer <SEU_TOKEN>

Sumário de avaliações do Google

GET /api/reviews/google/summary

Retorna o sumário agregado de avaliações do Google por empresa dentro do escopo autorizado pelo token de integração. Para tokens de empresa, a resposta sempre considera a empresa da integração. Para tokens de franquia, companies_id é opcional e será limitado ao subconjunto autorizado.

Parâmetros de Query

Parâmetro	Tipo	Obrigatório	Descrição
`date_start`	string	Sim	Data inicial no formato `YYYY-MM-DD`
`date_end`	string	Sim	Data final no formato `YYYY-MM-DD`
`companies_id`	string	Não	Lista CSV de IDs de empresas. Aplicável para token de franquia
`grade`	string	Não	Lista CSV de notas entre `1` e `5`

Exemplo de Requisição

bash

curl -X GET "https://api-b2s.experienciab2s.com/api/reviews/google/summary?date_start=2025-03-01&date_end=2025-03-31&grade=4,5" \
     -H "Authorization: Bearer SEU_TOKEN"

Resposta de Sucesso (200)

json

[
  {
    "rating": "4.5000",
    "total": "2",
    "published_rating": "4.7000",
    "total_answers": "128",
    "company_id": "803a525c-0ce3-4182-a504-aad595425233",
    "company_name": "Company Setup - 1",
    "answered": "1",
    "fiveStars": "1",
    "fourStars": "1",
    "threeStars": "0",
    "twoStars": "0",
    "oneStar": "0"
  }
]

Estrutura da Resposta

Campo	Tipo	Descrição
`rating`	string	Média das notas agregadas retornada pelo banco para os filtros da consulta
`total`	string	Total de avaliações consideradas no período e filtros informados
`published_rating`	string	Nota publicada do canal para a empresa
`total_answers`	string	Total geral de respostas do canal para a empresa
`company_id`	string	ID da empresa
`company_name`	string	Nome da empresa
`answered`	string	Quantidade de avaliações respondidas
`fiveStars`	string	Quantidade de avaliações com 5 estrelas
`fourStars`	string	Quantidade de avaliações com 4 estrelas
`threeStars`	string	Quantidade de avaliações com 3 estrelas
`twoStars`	string	Quantidade de avaliações com 2 estrelas
`oneStar`	string	Quantidade de avaliações com 1 estrela

Códigos de Resposta

Código	Descrição
200	Sumário agregado retornado com sucesso
400	Parâmetros inválidos
403	Token ausente ou não autorizado
404	Integração não encontrada

Sumário de avaliações do iFood

GET /api/reviews/ifood/summary

Retorna o sumário agregado de avaliações do iFood por empresa dentro do escopo autorizado pelo token de integração. Suporta filtros de domínio para nota, status, visibilidade e merchants.

Parâmetros de Query

Parâmetro	Tipo	Obrigatório	Descrição
`date_start`	string	Sim	Data inicial no formato `YYYY-MM-DD`
`date_end`	string	Sim	Data final no formato `YYYY-MM-DD`
`companies_id`	string	Não	Lista CSV de IDs de empresas. Aplicável para token de franquia
`grade`	string	Não	Lista CSV de notas entre `1` e `5`
`status`	string	Não	Status da avaliação. Valores permitidos: `CREATED`, `NOT_REPLIED`, `INVALID`, `REPLIED`, `PUBLISHED`, `DISCARDED`
`visibility`	string	Não	Visibilidade da avaliação. Valores permitidos: `public`, `private`
`merchants_id`	string	Não	Lista CSV de IDs de merchants do iFood

Exemplo de Requisição

bash

curl -X GET "https://api-b2s.experienciab2s.com/api/reviews/ifood/summary?date_start=2025-03-01&date_end=2025-03-31&status=REPLIED&visibility=public" \
     -H "Authorization: Bearer SEU_TOKEN"

Resposta de Sucesso (200)

json

[
  {
    "rating": "5.0000",
    "total": "1",
    "published_rating": "4.9000",
    "total_answers": "96",
    "company_id": "e03a525c-0ce3-4182-a504-aad595425233",
    "company_name": "Company Setup - 1",
    "answered": "1",
    "fiveStars": "1",
    "fourStars": "0",
    "threeStars": "0",
    "twoStars": "0",
    "oneStar": "0"
  }
]

Estrutura da Resposta

Campo	Tipo	Descrição
`rating`	string	Média das notas agregadas retornada pelo banco para os filtros da consulta
`total`	string	Total de avaliações consideradas no período e filtros informados
`published_rating`	string	Nota publicada do canal para a empresa
`total_answers`	string	Total geral de respostas do canal para a empresa
`company_id`	string	ID da empresa
`company_name`	string	Nome da empresa
`answered`	string	Quantidade de avaliações respondidas
`fiveStars`	string	Quantidade de avaliações com 5 estrelas
`fourStars`	string	Quantidade de avaliações com 4 estrelas
`threeStars`	string	Quantidade de avaliações com 3 estrelas
`twoStars`	string	Quantidade de avaliações com 2 estrelas
`oneStar`	string	Quantidade de avaliações com 1 estrela

Códigos de Resposta

Código	Descrição
200	Sumário agregado retornado com sucesso
400	Parâmetros inválidos
403	Token ausente ou não autorizado
404	Integração não encontrada

Sumário de avaliações do Trip

GET /api/reviews/trip/summary

Retorna o sumário agregado de avaliações do Trip por empresa dentro do escopo autorizado pelo token de integração. Para tokens de empresa, a resposta sempre considera a empresa da integração. Para tokens de franquia, companies_id é opcional e será limitado ao subconjunto autorizado.

Parâmetros de Query

Parâmetro	Tipo	Obrigatório	Descrição
`date_start`	string	Sim	Data inicial no formato `YYYY-MM-DD`
`date_end`	string	Sim	Data final no formato `YYYY-MM-DD`
`companies_id`	string	Não	Lista CSV de IDs de empresas. Aplicável para token de franquia
`grade`	string	Não	Lista CSV de notas entre `1` e `5`

Exemplo de Requisição

bash

curl -X GET "https://api-b2s.experienciab2s.com/api/reviews/trip/summary?date_start=2025-03-01&date_end=2025-03-31&grade=4,5" \
     -H "Authorization: Bearer SEU_TOKEN"

Resposta de Sucesso (200)

json

[
  {
    "rating": "4.8000",
    "total": "3",
    "published_rating": "4.6000",
    "total_answers": "87",
    "company_id": "f03a525c-0ce3-4182-a504-aad595425233",
    "company_name": "Company Setup - 1",
    "answered": "2",
    "fiveStars": "2",
    "fourStars": "1",
    "threeStars": "0",
    "twoStars": "0",
    "oneStar": "0"
  }
]

Estrutura da Resposta

Campo	Tipo	Descrição
`rating`	string	Média das notas agregadas retornada pelo banco para os filtros da consulta
`total`	string	Total de avaliações consideradas no período e filtros informados
`published_rating`	string	Nota publicada do canal para a empresa
`total_answers`	string	Total geral de respostas do canal para a empresa
`company_id`	string	ID da empresa
`company_name`	string	Nome da empresa
`answered`	string	Quantidade de avaliações respondidas
`fiveStars`	string	Quantidade de avaliações com 5 estrelas
`fourStars`	string	Quantidade de avaliações com 4 estrelas
`threeStars`	string	Quantidade de avaliações com 3 estrelas
`twoStars`	string	Quantidade de avaliações com 2 estrelas
`oneStar`	string	Quantidade de avaliações com 1 estrela

Códigos de Resposta

Código	Descrição
200	Sumário agregado retornado com sucesso
400	Parâmetros inválidos
403	Token ausente ou não autorizado
404	Integração não encontrada

Avaliações ​

Sumário de avaliações do Google ​

Parâmetros de Query ​

Exemplo de Requisição ​

Resposta de Sucesso (200) ​

Estrutura da Resposta ​

Códigos de Resposta ​

Sumário de avaliações do iFood ​

Parâmetros de Query ​

Exemplo de Requisição ​

Resposta de Sucesso (200) ​

Estrutura da Resposta ​

Códigos de Resposta ​

Sumário de avaliações do Trip ​

Parâmetros de Query ​

Exemplo de Requisição ​

Resposta de Sucesso (200) ​

Estrutura da Resposta ​

Códigos de Resposta ​

Avaliações

Sumário de avaliações do Google

Parâmetros de Query

Exemplo de Requisição

Resposta de Sucesso (200)

Estrutura da Resposta

Códigos de Resposta

Sumário de avaliações do iFood

Parâmetros de Query

Exemplo de Requisição

Resposta de Sucesso (200)

Estrutura da Resposta

Códigos de Resposta

Sumário de avaliações do Trip

Parâmetros de Query

Exemplo de Requisição

Resposta de Sucesso (200)

Estrutura da Resposta

Códigos de Resposta