Appearance
Relatórios
Endpoints para consulta dos relatórios diário, semanal e mensal da rede, com o mesmo conteúdo exibido na tela do Falaê, incluindo as análises geradas pelo Fala.AI.
Base URL das rotas: /api/reports
Autenticação obrigatória em todas as rotas:
bash
Authorization: Bearer <SEU_TOKEN>Rede ou unidade
O relatório retornado depende do token de integração:
- Token de rede: sem
company_id, retorna o relatório consolidado da rede. Com ocompany_idde uma empresa da rede, retorna o relatório dessa unidade. - Token de unidade: retorna sempre o relatório da própria unidade, mesmo sem
company_id.
O token não dá acesso a outras redes nem a empresas fora da rede.
Dados incluídos:
- Indicadores de NPS, respostas e clientes do período
- Ranking dos atendentes com a análise da equipe do Fala.AI (
attendants.ai_insight), nos relatórios semanal e mensal - Conversão de cupons com a análise de cupons do Fala.AI (
conversion.coupon_analysis), nos relatórios semanal e mensal - Critérios avaliados, perguntas qualitativas e lembretes
- Avaliações externas e impacto financeiro (semanal e mensal)
- Persona e relatório de aniversariantes (mensal)
Casos de uso:
- Apresentar os relatórios da rede de forma consolidada
- Alimentar dashboards e agentes de IA externos
- Acompanhar as análises do Fala.AI fora da plataforma
Campos opcionais
Os campos conversion, answers e ticket só aparecem quando o período teve respostas. attendants.ai_insight e conversion.coupon_analysis só aparecem quando o Fala.AI gerou a análise.
Relatório Diário
GET /api/reports/daily
Retorna o relatório diário da rede ou da unidade para a data informada.
Sem análise do Fala.AI
O relatório diário não tem análise do Fala.AI. A resposta é sempre 200 com o relatório, sem processamento assíncrono.
Parâmetros de Query
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
date | string | Sim | Data do relatório no formato YYYY-MM-DD |
company_id | string (UUID) | Não | ID de uma unidade da rede, para token de rede. Sem company_id, retorna o relatório consolidado da rede. Com token de unidade, o relatório é sempre o da própria unidade |
Exemplo de Requisição
bash
curl -X GET "https://api-b2s.experienciab2s.com/api/reports/daily?date=2026-11-13" \
-H "Authorization: Bearer SEU_TOKEN"Resposta de Sucesso (200)
json
{
"id": 1520,
"conversion": {
"total_answers": 48,
"total_clients": 41,
"created_coupons": 12,
"used_coupons": 5
},
"answers": {
"data_chart": [
{
"type": "0h",
"value": 0,
"registered_total": 0,
"unregistered_total": 0
},
{
"type": "3h",
"value": 0,
"registered_total": 0,
"unregistered_total": 0
},
{
"type": "6h",
"value": 0,
"registered_total": 0,
"unregistered_total": 0
},
{
"type": "9h",
"value": 4,
"registered_total": 3,
"unregistered_total": 1
},
{
"type": "12h",
"value": 14,
"registered_total": 12,
"unregistered_total": 2
},
{
"type": "15h",
"value": 9,
"registered_total": 8,
"unregistered_total": 1
},
{
"type": "18h",
"value": 15,
"registered_total": 13,
"unregistered_total": 2
},
{
"type": "21h",
"value": 6,
"registered_total": 5,
"unregistered_total": 1
}
],
"clients": 41,
"detractor": 4,
"neutral": 6,
"nps": 71,
"nps_variation": 3,
"promoter": 38,
"time_end_with_highest_flow": "20:00",
"time_start_with_highest_flow": "19:00",
"day_with_highest_flow": "Sexta",
"total_day_with_highest_flow": 48,
"detractor_time_start_with_highest_flow": "12:00",
"detractor_time_end_with_highest_flow": "13:00",
"total_detractor_time_with_highest_flow": 2,
"detractor_day_with_highest_flow": "Sexta",
"total_detractor_day_with_highest_flow": 4,
"registered_responses": 41,
"unregistered_responses": 7,
"recurring_responses": 9,
"birthday_respondents": 2,
"total": 48,
"suggestion": "Reforçar a equipe no horário de pico do almoço para reduzir o tempo de espera.",
"nps_distribution_sell_more": "Ofereça um cupom de retorno aos neutros para transformá-los em promotores.",
"next_period_focus": {
"criterion_id": 2,
"title": "Tempo de espera",
"reason": "Critério com o menor NPS do dia e com a maior concentração de detratores."
},
"nps_distribution_analysis": "A maior parte das respostas veio de promotores, com detratores concentrados no almoço.",
"registration_analysis": "85% das respostas foram de clientes cadastrados.",
"registration_sell_more": "Incentive o cadastro no caixa para ampliar a base de clientes identificados."
},
"attendants": {
"first_name": "Ana",
"first_total": 18,
"second_name": "Bruno",
"second_total": 12,
"third_name": "Carla",
"third_total": 9
},
"qualitative": [
{
"data_chart": [
{
"type": "Instagram",
"value": 18
},
{
"type": "Indicação",
"value": 15
},
{
"type": "Google",
"value": 10
}
],
"nick": "Como nos conheceu",
"type": "Multipla escolha",
"summary": "Instagram e indicação de amigos foram os principais canais de aquisição do dia."
}
],
"reminders": {
"birthdays": 3,
"expiring_coupons": 7,
"used_coupons": 5
},
"quantitative": [
{
"data_chart": [
{
"type": "Promotores",
"value": 40
},
{
"type": "Neutros",
"value": 5
},
{
"type": "Detratores",
"value": 3
}
],
"nps": 77,
"previous_nps": 72,
"question_id": "6f1c2b9e-4a3d-4f7a-9b2e-1d5c8a7e3f10",
"total": 48,
"nick": "Atendimento",
"type": "NPS",
"zone": "Zona de Excelência",
"suggestions_total": 6,
"positive_points": "Cordialidade e atenção da equipe.",
"negative_points": "Demora pontual na retirada dos pedidos."
},
{
"data_chart": [
{
"type": "Promotores",
"value": 30
},
{
"type": "Neutros",
"value": 8
},
{
"type": "Detratores",
"value": 10
}
],
"nps": 42,
"previous_nps": null,
"question_id": null,
"total": 48,
"nick": "Tempo de espera",
"type": "NPS",
"zone": "Zona de Aperfeiçoamento",
"suggestions_total": 0,
"positive_points": "Agilidade no período da tarde.",
"negative_points": "Fila longa no horário do almoço."
}
]
}Estrutura da Resposta
| Campo | Tipo | Descrição |
|---|---|---|
id | integer | ID do relatório |
conversion | object | Conversão de cupons |
answers | object | Indicadores das respostas. No diário, data_chart é agrupado por horário (0h a 21h) |
attendants | object | Atendentes |
qualitative | array | Perguntas qualitativas |
reminders | object | Lembretes do dia |
quantitative | array | Critérios avaliados |
Códigos de Resposta
| Código | Descrição |
|---|---|
| 200 | Relatório retornado com sucesso |
| 400 | Parâmetros inválidos |
| 403 | Token ausente ou não autorizado |
| 404 | Integração não encontrada ou relatório não gerado para a data |
Relatório Semanal
GET /api/reports/weekly
Retorna o relatório semanal da rede ou da unidade para o período informado.
Parâmetros de Query
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
date_start | string | Sim | Segunda-feira que inicia a semana do relatório, no formato YYYY-MM-DD |
date_end | string | Sim | Domingo que encerra a semana do relatório, no formato YYYY-MM-DD |
company_id | string (UUID) | Não | ID de uma unidade da rede, para token de rede. Sem company_id, retorna o relatório consolidado da rede. Com token de unidade, o relatório é sempre o da própria unidade |
Período da semana
O relatório semanal vai sempre de segunda-feira a domingo, por exemplo de 09/11/2026 a 15/11/2026 (date_start=2026-11-09&date_end=2026-11-15). Informe em date_start a segunda-feira e em date_end o domingo da mesma semana.
Exemplo de Requisição
bash
curl -X GET "https://api-b2s.experienciab2s.com/api/reports/weekly?date_start=2026-11-02&date_end=2026-11-08" \
-H "Authorization: Bearer SEU_TOKEN"Resposta de Sucesso (200)
json
{
"id": 1498,
"attendants": {
"first_name": "Ana",
"first_total": 96,
"second_name": "Bruno",
"second_total": 81,
"third_name": "Carla",
"third_total": 64,
"ai_insight": {
"title": "Análise da equipe",
"content": "Ana manteve a liderança em respostas positivas durante a semana. As menções negativas se concentraram no sábado à noite, quando a equipe estava reduzida."
}
},
"qualitative": [
{
"data_chart": [
{
"type": "Instagram",
"value": 120
},
{
"type": "Indicação",
"value": 110
},
{
"type": "Google",
"value": 90
}
],
"nick": "Como nos conheceu",
"type": "Multipla escolha",
"summary": "Instagram segue como principal canal, com crescimento das indicações no fim de semana."
}
],
"quantitative": [
{
"data_chart": [
{
"type": "Promotores",
"value": 270
},
{
"type": "Neutros",
"value": 30
},
{
"type": "Detratores",
"value": 20
}
],
"nps": 78,
"previous_nps": 74,
"question_id": "6f1c2b9e-4a3d-4f7a-9b2e-1d5c8a7e3f10",
"total": 320,
"nick": "Atendimento",
"type": "NPS",
"zone": "Zona de Excelência",
"suggestions_total": 21,
"positive_points": "Cordialidade e atenção da equipe.",
"negative_points": "Demora no atendimento no sábado à noite."
}
],
"reminders": {
"birthdays": 14,
"expiring_coupons": 22,
"used_coupons": 40
},
"external_ratings": [
{
"grade": 4.6,
"total_reviews": 58,
"fiveStar": 42,
"fourStar": 9,
"oneStar": 2,
"threeStar": 3,
"twoStar": 2,
"name": "Google"
}
],
"conversion": {
"total_answers": 320,
"total_clients": 250,
"created_coupons": 95,
"used_coupons": 40,
"coupon_analysis": "A taxa de uso dos cupons foi de 42% na semana, puxada pelos cupons de retorno enviados aos neutros."
},
"answers": {
"data_chart": [
{
"type": "Segunda",
"value": 30,
"registered_total": 26,
"unregistered_total": 4
},
{
"type": "Terça",
"value": 35,
"registered_total": 30,
"unregistered_total": 5
},
{
"type": "Quarta",
"value": 40,
"registered_total": 35,
"unregistered_total": 5
},
{
"type": "Quinta",
"value": 45,
"registered_total": 39,
"unregistered_total": 6
},
{
"type": "Sexta",
"value": 60,
"registered_total": 52,
"unregistered_total": 8
},
{
"type": "Sábado",
"value": 70,
"registered_total": 61,
"unregistered_total": 9
},
{
"type": "Domingo",
"value": 40,
"registered_total": 34,
"unregistered_total": 6
}
],
"clients": 250,
"detractor": 25,
"neutral": 35,
"nps": 73,
"nps_variation": -2,
"promoter": 260,
"time_end_with_highest_flow": "21:00",
"time_start_with_highest_flow": "20:00",
"day_with_highest_flow": "Sábado",
"total_day_with_highest_flow": 70,
"detractor_time_start_with_highest_flow": "20:00",
"detractor_time_end_with_highest_flow": "21:00",
"total_detractor_time_with_highest_flow": 8,
"detractor_day_with_highest_flow": "Sábado",
"total_detractor_day_with_highest_flow": 9,
"registered_responses": 277,
"unregistered_responses": 43,
"recurring_responses": 64,
"birthday_respondents": 6,
"total": 320,
"suggestion": "Escalar mais um atendente para o sábado à noite.",
"nps_distribution_sell_more": "Convide os promotores do fim de semana para avaliar a loja no Google.",
"next_period_focus": {
"criterion_id": 2,
"title": "Tempo de espera",
"reason": "Critério com queda de NPS em relação à semana anterior."
},
"nps_distribution_analysis": "O NPS caiu 2 pontos, com detratores concentrados no sábado à noite.",
"registration_analysis": "87% das respostas foram de clientes cadastrados.",
"registration_sell_more": "Ofereça um benefício no primeiro cadastro para os clientes sem identificação."
},
"ticket": {
"averageTicket": 85.5,
"potentialRevenueGain": 66690,
"potentialRevenueLoss": 25650,
"reputationFinancialBalance": 41040,
"potentialRevenueRecovery": 1496.25,
"couponRevenueGain": 3420
}
}Estrutura da Resposta
| Campo | Tipo | Descrição |
|---|---|---|
id | integer | ID do relatório |
attendants | object | Atendentes com a análise da equipe do Fala.AI |
qualitative | array | Perguntas qualitativas |
quantitative | array | Critérios avaliados |
reminders | object | Lembretes da semana |
external_ratings | array | Avaliações externas |
conversion | object | Conversão de cupons com a análise de cupons do Fala.AI |
answers | object | Indicadores das respostas. No semanal, data_chart é agrupado por dia da semana (Segunda a Domingo) |
ticket | object | Impacto financeiro |
Códigos de Resposta
| Código | Descrição |
|---|---|
| 200 | Relatório retornado com sucesso |
| 202 | Análise do Fala.AI em geração. Veja Relatórios sem análise do Fala.AI |
| 400 | Parâmetros inválidos ou período diferente de 7 dias |
| 403 | Token ausente ou não autorizado |
| 404 | Integração não encontrada ou relatório não gerado para o período |
Relatório Mensal
GET /api/reports/monthly
Retorna o relatório mensal da rede ou da unidade para o mês informado.
Parâmetros de Query
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
date | string | Sim | Mês do relatório no formato YYYY-MM |
company_id | string (UUID) | Não | ID de uma unidade da rede, para token de rede. Sem company_id, retorna o relatório consolidado da rede. Com token de unidade, o relatório é sempre o da própria unidade |
Exemplo de Requisição
bash
curl -X GET "https://api-b2s.experienciab2s.com/api/reports/monthly?date=2026-10" \
-H "Authorization: Bearer SEU_TOKEN"Resposta de Sucesso (200)
json
{
"id": 1475,
"persona": {
"status": "generated",
"message": null,
"persona": {
"image_drive_id": "1eu-P1H9levns3o0m6Kg-NalFGNtmr-jN",
"fictionalName": "Mariana",
"catchphrase": "Gosto de ser atendida pelo nome e sem pressa.",
"profile": "Cliente recorrente, visita a loja à noite com a família e valoriza atendimento atencioso.",
"classification": "promoter",
"motivations": [
"Ambiente acolhedor",
"Atendimento personalizado"
],
"behaviors": [
"Visita a loja aos fins de semana",
"Responde às pesquisas"
],
"preferences": [
"Cupons de retorno",
"Mesas na área externa"
],
"expectations": [
"Pedidos entregues sem demora"
],
"improvement_opportunities": [
"Reduzir a espera nos horários de pico"
]
}
},
"attendants": {
"first_name": "Ana",
"first_total": 390,
"second_name": "Bruno",
"second_total": 320,
"third_name": "Carla",
"third_total": 265,
"ai_insight": {
"title": "Análise da equipe",
"content": "A equipe manteve o padrão de atendimento ao longo do mês. Ana e Bruno somaram a maior parte dos elogios e as críticas se concentraram na última semana."
}
},
"qualitative": [
{
"data_chart": [
{
"type": "Instagram",
"value": 480
},
{
"type": "Indicação",
"value": 430
},
{
"type": "Google",
"value": 340
}
],
"nick": "Como nos conheceu",
"type": "Multipla escolha",
"summary": "Instagram foi o principal canal de aquisição do mês, seguido pelas indicações."
}
],
"quantitative": [
{
"data_chart": [
{
"type": "Promotores",
"value": 1050
},
{
"type": "Neutros",
"value": 120
},
{
"type": "Detratores",
"value": 80
}
],
"nps": 78,
"previous_nps": 75,
"question_id": "6f1c2b9e-4a3d-4f7a-9b2e-1d5c8a7e3f10",
"total": 1250,
"nick": "Atendimento",
"type": "NPS",
"zone": "Zona de Excelência",
"suggestions_total": 84,
"positive_points": "Cordialidade e atenção da equipe.",
"negative_points": "Demora no atendimento na última semana do mês."
}
],
"reminders": {
"birthdays": 52,
"expiring_coupons": 70,
"used_coupons": 160,
"expired_coupons": 35,
"next_month_expiring_coupons": 48,
"active_coupons_balance": 210
},
"external_ratings": [
{
"grade": 4.6,
"total_reviews": 230,
"fiveStar": 168,
"fourStar": 36,
"oneStar": 8,
"threeStar": 12,
"twoStar": 6,
"name": "Google"
}
],
"conversion": {
"total_answers": 1250,
"total_clients": 980,
"created_coupons": 380,
"used_coupons": 160,
"coupon_analysis": "O uso de cupons cresceu 12% em relação ao mês anterior, com destaque para os cupons de aniversário."
},
"answers": {
"data_chart": [
{
"type": "1 ao dia 7",
"value": 280,
"registered_total": 240,
"unregistered_total": 40
},
{
"type": "8 ao dia 14",
"value": 300,
"registered_total": 260,
"unregistered_total": 40
},
{
"type": "15 ao dia 21",
"value": 290,
"registered_total": 250,
"unregistered_total": 40
},
{
"type": "22 ao dia 27",
"value": 240,
"registered_total": 205,
"unregistered_total": 35
},
{
"type": "28 ao dia 31",
"value": 140,
"registered_total": 120,
"unregistered_total": 20
}
],
"clients": 980,
"detractor": 100,
"neutral": 150,
"nps": 72,
"nps_variation": 4,
"promoter": 1000,
"time_end_with_highest_flow": "21:00",
"time_start_with_highest_flow": "20:00",
"day_with_highest_flow": "Sábado",
"total_day_with_highest_flow": 260,
"detractor_time_start_with_highest_flow": "12:00",
"detractor_time_end_with_highest_flow": "13:00",
"total_detractor_time_with_highest_flow": 22,
"detractor_day_with_highest_flow": "Sábado",
"total_detractor_day_with_highest_flow": 30,
"registered_responses": 1075,
"unregistered_responses": 175,
"recurring_responses": 310,
"birthday_respondents": 41,
"total": 1250,
"suggestion": "Manter a escala reforçada nos sábados e revisar o processo de retirada no almoço.",
"nps_distribution_sell_more": "Crie uma campanha de indicação para os promotores do mês.",
"next_period_focus": {
"criterion_id": 2,
"title": "Tempo de espera",
"reason": "Critério com o menor NPS do mês."
},
"nps_distribution_analysis": "O NPS subiu 4 pontos, com aumento de promotores nas três primeiras semanas.",
"registration_analysis": "86% das respostas foram de clientes cadastrados.",
"registration_sell_more": "Use o cadastro para enviar cupons de retorno personalizados."
},
"ticket": {
"averageTicket": 85.5,
"potentialRevenueGain": 256500,
"potentialRevenueLoss": 102600,
"reputationFinancialBalance": 153900,
"potentialRevenueRecovery": 5985,
"couponRevenueGain": 13680
},
"birthdayReport": {
"id": 312,
"report_id": 1475,
"answer_report_id": 1380,
"total": 41,
"promoters_total": 36,
"nps": 83,
"day_with_highest_flow": "Sábado",
"total_day_with_highest_flow": 12,
"time_start_with_highest_flow": "20:00",
"time_end_with_highest_flow": "21:00",
"total_time_with_highest_flow": 7,
"sell_more": "Envie o cupom de aniversário na semana anterior à data para antecipar a visita.",
"created_at": "2026-11-01T06:00:12.000Z",
"updated_at": "2026-11-01T06:00:12.000Z"
}
}Estrutura da Resposta
| Campo | Tipo | Descrição |
|---|---|---|
id | integer | ID do relatório |
persona | object | Persona gerada pelo Fala.AI |
attendants | object | Atendentes com a análise da equipe do Fala.AI |
qualitative | array | Perguntas qualitativas |
quantitative | array | Critérios avaliados |
reminders | object | Lembretes do mês, com os campos extras de cupons |
external_ratings | array | Avaliações externas |
conversion | object | Conversão de cupons com a análise de cupons do Fala.AI |
answers | object | Indicadores das respostas. No mensal, data_chart é agrupado por intervalo de dias (1 ao dia 7 a 28 ao dia 31) |
ticket | object | Impacto financeiro |
birthdayReport | object | Relatório de aniversariantes. Ausente quando não foi gerado |
Códigos de Resposta
| Código | Descrição |
|---|---|
| 200 | Relatório retornado com sucesso |
| 202 | Análise do Fala.AI em geração. Veja Relatórios sem análise do Fala.AI |
| 400 | Parâmetros inválidos |
| 403 | Token ausente ou não autorizado |
| 404 | Integração não encontrada ou relatório não gerado para o mês |
Relatórios sem análise do Fala.AI
Os relatórios semanal e mensal podem ser gerados sem a análise do Fala.AI. A API nunca espera a geração:
- Relatório com análise: o relatório pronto, com qualquer análise do Fala.AI, responde 200 normalmente.
- Relatório sem análise: a resposta é 202 com o
request_id, e o Falaê inicia a geração da análise.
O mesmo relatório pedido de novo enquanto a análise está em geração retorna o mesmo request_id, sem iniciar outra geração. Um processamento em processing há mais de 60 minutos expira, e a próxima requisição do relatório cria um novo request_id.
Ao receber o 202, consulte o processamento em GET /api/requests/:request_id até o status done e use o relatório em data, ou repita a requisição do relatório, que passa a responder 200.
Resposta em processamento (202)
bash
curl -X GET "https://api-b2s.experienciab2s.com/api/reports/weekly?date_start=2026-11-02&date_end=2026-11-08" \
-H "Authorization: Bearer SEU_TOKEN"json
{
"request_id": "6f1c0a7e-2d4b-4b8e-9a51-3c2f8d7e1b90",
"status": "processing"
}O status da resposta 202 é sempre processing.
Consultar o processamento
GET /api/requests/:request_id
Retorna o status de um processamento criado pelo seu token. O request_id de outro token responde 404 (Request not found).
bash
curl -X GET "https://api-b2s.experienciab2s.com/api/requests/6f1c0a7e-2d4b-4b8e-9a51-3c2f8d7e1b90" \
-H "Authorization: Bearer SEU_TOKEN"Processamento concluído, com o relatório em data:
json
{
"request_id": "6f1c0a7e-2d4b-4b8e-9a51-3c2f8d7e1b90",
"type": "weekly_report",
"status": "done",
"data": { "id": 1250, "attendants": { "...": "..." } },
"created_at": "2026-11-14T09:10:02.000Z",
"updated_at": "2026-11-14T09:12:41.000Z"
}Análise ainda em geração, sem data:
json
{
"request_id": "6f1c0a7e-2d4b-4b8e-9a51-3c2f8d7e1b90",
"type": "weekly_report",
"status": "processing",
"created_at": "2026-11-14T09:10:02.000Z",
"updated_at": "2026-11-14T09:10:02.000Z"
}| Campo | Tipo | Descrição |
|---|---|---|
request_id | string (UUID) | Identificador do processamento |
type | string | weekly_report ou monthly_report |
status | string | processing, done ou failed |
data | object | Relatório pronto, com o mesmo conteúdo da resposta 200 do relatório semanal ou do relatório mensal. Somente quando o status é done |
created_at | string | Data de criação |
updated_at | string | Data da última atualização |
| Código | Descrição |
|---|---|
| 200 | Processamento retornado com sucesso |
| 400 | request_id inválido |
| 403 | Token ausente ou não autorizado |
| 404 | Integração ou processamento não encontrado |
Estruturas dos Relatórios
Atendentes
| Campo | Tipo | Descrição |
|---|---|---|
first_name | string | Atendente com mais respostas |
first_total | integer | Respostas do primeiro atendente |
second_name | string | Segundo atendente com mais respostas |
second_total | integer | Respostas do segundo atendente |
third_name | string | Terceiro atendente com mais respostas |
third_total | integer | Respostas do terceiro atendente |
ai_insight | object | Análise dos atendentes gerada pelo Fala.AI, com title (Análise da equipe) e content. Ausente quando não há análise |
Conversão de Cupons
| Campo | Tipo | Descrição |
|---|---|---|
total_answers | integer | Total de respostas |
total_clients | integer | Total de clientes |
created_coupons | integer | Cupons criados |
used_coupons | integer | Cupons utilizados |
coupon_analysis | string | Análise de cupons gerada pelo Fala.AI. Ausente quando não há análise |
Indicadores das Respostas
| Campo | Tipo | Descrição |
|---|---|---|
data_chart | array | Respostas por faixa, com type, value, registered_total e unregistered_total |
clients | integer | Clientes únicos |
detractor | integer | Detratores |
neutral | integer | Neutros |
nps | number | NPS do período |
nps_variation | number | Variação em relação ao período anterior |
promoter | integer | Promotores |
time_end_with_highest_flow | string | Fim do horário com maior fluxo |
time_start_with_highest_flow | string | Início do horário com maior fluxo |
day_with_highest_flow | string | Dia com maior fluxo |
total_day_with_highest_flow | integer | Respostas no dia com maior fluxo |
detractor_time_start_with_highest_flow | string | null | Início do horário com mais detratores |
detractor_time_end_with_highest_flow | string | null | Fim do horário com mais detratores |
total_detractor_time_with_highest_flow | integer | Detratores no horário com mais detratores |
detractor_day_with_highest_flow | string | null | Dia com mais detratores |
total_detractor_day_with_highest_flow | integer | Detratores no dia com mais detratores |
registered_responses | integer | Respostas de clientes cadastrados |
unregistered_responses | integer | Respostas sem cadastro |
recurring_responses | integer | null | Respostas de clientes recorrentes |
birthday_respondents | integer | null | Aniversariantes que responderam |
total | integer | Total de respostas |
suggestion | string | Sugestão gerada pelo Fala.AI |
nps_distribution_sell_more | string | null | Sugestão do Fala.AI para vender mais a partir da distribuição do NPS |
next_period_focus | object | null | Critério sugerido pelo Fala.AI como foco do próximo período, com criterion_id, title e reason |
nps_distribution_analysis | string | null | Análise do Fala.AI sobre a distribuição do NPS |
registration_analysis | string | null | Análise do Fala.AI sobre o cadastro dos clientes |
registration_sell_more | string | null | Sugestão do Fala.AI para vender mais a partir do cadastro |
Perguntas Qualitativas
| Campo | Tipo | Descrição |
|---|---|---|
data_chart | array | Total por opção, com type e value |
nick | string | Apelido da pergunta |
type | string | Tipo da pergunta |
summary | string | null | Resumo gerado pelo Fala.AI |
Critérios Avaliados
| Campo | Tipo | Descrição |
|---|---|---|
data_chart | array | Promotores, neutros e detratores do critério, com type e value |
nps | number | NPS do critério |
previous_nps | number | null | NPS do critério no período anterior |
question_id | string | null | ID da pergunta usada nas sugestões |
total | integer | Total de respostas do critério |
nick | string | Nome do critério |
type | string | Tipo do critério |
zone | string | Zona do NPS: Zona Crítica, Zona de Aperfeiçoamento, Zona de Qualidade ou Zona de Excelência |
suggestions_total | integer | Total de sugestões do critério |
positive_points | string | Pontos positivos gerados pelo Fala.AI |
negative_points | string | Pontos negativos gerados pelo Fala.AI |
Lembretes
| Campo | Tipo | Descrição |
|---|---|---|
birthdays | integer | Aniversariantes |
expiring_coupons | integer | Cupons a vencer |
used_coupons | integer | Cupons utilizados |
expired_coupons | integer | Cupons vencidos. Somente no mensal |
next_month_expiring_coupons | integer | Cupons que vencem no próximo mês. Somente no mensal |
active_coupons_balance | integer | Saldo de cupons ativos. Somente no mensal |
Avaliações Externas
| Campo | Tipo | Descrição |
|---|---|---|
grade | number | Nota média |
total_reviews | integer | Total de avaliações |
fiveStar | integer | Avaliações com 5 estrelas |
fourStar | integer | Avaliações com 4 estrelas |
oneStar | integer | Avaliações com 1 estrela |
threeStar | integer | Avaliações com 3 estrelas |
twoStar | integer | Avaliações com 2 estrelas |
name | string | Canal de reputação |
Impacto Financeiro
| Campo | Tipo | Descrição |
|---|---|---|
averageTicket | number | Ticket médio |
potentialRevenueGain | number | Ganho potencial de receita |
potentialRevenueLoss | number | Perda potencial de receita |
reputationFinancialBalance | number | Saldo financeiro da reputação |
potentialRevenueRecovery | number | Recuperação potencial de receita |
couponRevenueGain | number | Receita gerada por cupons |
Persona
| Campo | Tipo | Descrição |
|---|---|---|
status | string | generated quando a persona foi gerada ou insufficient_data quando não há dados suficientes |
message | string | null | Mensagem quando não há dados suficientes |
persona | object | null | Persona gerada pelo Fala.AI, com image_drive_id, fictionalName, catchphrase, profile, classification (promoter, neutral ou detractor), motivations, behaviors, preferences, expectations e improvement_opportunities |
Quando o mês não teve respostas, persona retorna status igual a insufficient_data. Quando a persona armazenada não é válida, persona retorna null.
Relatório de Aniversariantes
| Campo | Tipo | Descrição |
|---|---|---|
id | integer | ID do relatório de aniversariantes |
report_id | integer | ID do relatório mensal |
answer_report_id | integer | ID do relatório de respostas |
total | integer | Respostas de aniversariantes |
promoters_total | integer | Aniversariantes promotores |
nps | number | NPS dos aniversariantes |
day_with_highest_flow | string | Dia com maior fluxo |
total_day_with_highest_flow | integer | Respostas no dia com maior fluxo |
time_start_with_highest_flow | string | Início do horário com maior fluxo |
time_end_with_highest_flow | string | Fim do horário com maior fluxo |
total_time_with_highest_flow | integer | Respostas no horário com maior fluxo |
sell_more | string | Sugestão do Fala.AI para vender mais aos aniversariantes |
created_at | string | Data de criação |
updated_at | string | Data de atualização |
Erros
Os erros seguem o formato padrão da API:
json
{
"status": "error",
"message": "Report not found"
}| Código | Mensagem | Quando ocorre |
|---|---|---|
| 400 | date is required | Filtro obrigatório ausente ou em formato inválido. A mensagem indica o campo |
| 400 | The difference between date_start and date_end must be exactly 7 days. | Período do relatório semanal diferente de 7 dias |
| 400 | date must be in the format YYYY-MM | Mês do relatório mensal fora do formato YYYY-MM |
| 400 | company_id must be a valid UUID | company_id fora do formato UUID |
| 403 | This action is unauthorized. | Token ausente ou não autorizado |
| 404 | Integration not found | Token de integração não encontrado |
| 404 | Report not found | Nenhum relatório gerado para a data, o período ou o mês informado |
| 404 | Companies not found. | company_id de uma empresa fora da rede do token ou diferente da unidade do token |
| 404 | Request not found | Processamento inexistente ou criado por outro token |
