Plataforma › Empresas clientes
Painel da plataforma
GET/api/v1/admin/dashboardPede sessãoComo funciona
O painel da plataforma: os números da operação de todas as empresas clientes (volume movimentado, receita, plantões, médicos), as séries dos últimos 12 meses, as tendências em relação ao período anterior, o faturamento por mês, o atendimento por empresa e a tabela de saúde de cada cliente.
Com tenantId, todos os números passam a ser só daquela empresa. A tabela de saúde continua com todas, porque é dela que sai o seletor de empresa do topo.
É da equipe interna e pede o módulo Painel no papel de quem chama.
Parâmetros
tenantIdQuery · stringMostra os números de uma empresa cliente só.
Respostas
200 · Os indicadores, as séries, as tendências e a saúde dos clientes.
billingSeriesobject[] · Faturamento por mês.billingSeries[].invoicedCentsinteger · Faturado, em centavos.billingSeries[].monthstring · Mês.billingSeries[].receivedCentsinteger · Recebido, em centavos.gmvSeriesobject[] · Volume movimentado por mês.gmvSeries[].gmvCentsinteger · Volume movimentado, em centavos.gmvSeries[].monthstring · Mês.gmvSeries[].revenueCentsinteger · Receita, em centavos.kpisobject · Indicadores do período.kpis.activeCompaniesinteger · Empresas ativas.kpis.activeCompaniesTrendPctnumber · Variação das empresas ativas sobre o período anterior, em porcentagem.kpis.gmvCentsinteger · Volume movimentado, em centavos.kpis.gmvTrendPctnumber · Variação do volume sobre o período anterior, em porcentagem.kpis.openAdvancesCentsinteger · Antecipações em aberto, em centavos.kpis.openAdvancesCountinteger · Quantas antecipações em aberto.kpis.platformRevenueCentsinteger · Receita da plataforma, em centavos.kpis.platformRevenueTrendPctnumber · Variação da receita sobre o período anterior, em porcentagem.kpis.shiftsInMonthinteger · Plantões no mês.kpis.shiftsInMonthTrendPctnumber · Variação dos plantões sobre o período anterior, em porcentagem.kpis.totalActiveDoctorsinteger · Médicos ativos.kpis.totalActiveDoctorsTrendPctnumber · Variação dos médicos ativos sobre o período anterior, em porcentagem.revenueByTenantobject[] · Receita por empresa.revenueByTenant[].revenueCentsinteger · Receita, em centavos.revenueByTenant[].tenantIdstring · Identificador da empresa cliente.revenueByTenant[].tenantNamestring · Empresa cliente.supportByTenantobject[] · Atendimento por empresa.supportByTenant[].openAlertsinteger · Alertas abertos.supportByTenant[].openTicketsinteger · Chamados abertos.supportByTenant[].tenantIdstring · Identificador da empresa cliente.supportByTenant[].tenantNamestring · Empresa cliente.tenantHealthobject[] · Saúde de cada empresa cliente.tenantHealth[].doctorsCountinteger · Quantos médicos a empresa tem.tenantHealth[].healthScoreinteger · Health score de 0 a 100, calculado todo dia às 5h30 (Brasília) sobre os últimos 3 meses, com os pesos: pagamentos 35 (fatura em dia vale 1, paga com atraso ou renegociada vale meio, vencida sem pagar vale 0), uso de antecipações 20 (metade é a adesão dos médicos, cheia com 30% deles antecipando; metade é ficar dentro do limite de crédito), crescimento de médicos 15, de escalas 15 e de plantões 15 (manter o tamanho vale 60, crescer 40% ou mais vale 100, encolher 60% ou mais vale 0). Nulo para empresa com menos de 3 meses ou que ainda não foi calculada.tenantHealth[].healthTierstring · Faixa do health score:greende 70 a 100,amberde 40 a 69,redabaixo de 40. Ausente quando não há nota.tenantHealth[].monthlyVolumeCentsinteger · Volume movimentado no mês, em centavos.tenantHealth[].schedulesCountinteger · Quantas escalas a empresa tem.tenantHealth[].statusstring · Situação.tenantHealth[].tenantIdstring · Identificador da empresa cliente.tenantHealth[].tenantNamestring · Empresa cliente.tenantsobject[] · Empresas clientes.tenants[].idstring · Identificador do registro.tenants[].namestring · Nome.
Corpo de exemplo
{
"billingSeries": [
{
"invoicedCents": 150000,
"month": "texto",
"receivedCents": 150000
}
],
"gmvSeries": [
{
"gmvCents": 150000,
"month": "texto",
"revenueCents": 150000
}
],
"kpis": {
"activeCompanies": 1,
"activeCompaniesTrendPct": 1,
"gmvCents": 150000,
"gmvTrendPct": 1,
"openAdvancesCents": 150000,
"openAdvancesCount": 1,
"platformRevenueCents": 150000,
"platformRevenueTrendPct": 1,
"shiftsInMonth": 1,
"shiftsInMonthTrendPct": 1,
"totalActiveDoctors": 1,
"totalActiveDoctorsTrendPct": 1
},
"revenueByTenant": [
{
"revenueCents": 150000,
"tenantId": "3f0c2a5e-9b1d-4c7e-8a21-6d0f5b7ca91e",
"tenantName": "texto"
}
],
"supportByTenant": [
{
"openAlerts": 1,
"openTickets": 1,
"tenantId": "3f0c2a5e-9b1d-4c7e-8a21-6d0f5b7ca91e",
"tenantName": "texto"
}
],
"tenantHealth": [
{
"doctorsCount": 1,
"healthScore": 1,
"healthTier": "texto",
"monthlyVolumeCents": 150000,
"schedulesCount": 1,
"status": "texto",
"tenantId": "3f0c2a5e-9b1d-4c7e-8a21-6d0f5b7ca91e",
"tenantName": "texto"
}
],
"tenants": [
{
"id": "3f0c2a5e-9b1d-4c7e-8a21-6d0f5b7ca91e",
"name": "texto"
}
]
}