Painel da empresa › Dashboard
Painel completo numa chamada
GET/api/v1/dashboard/aggregatePede sessãoComo funciona
O painel inteiro numa chamada só: indicadores, seções, plantões do período, escalas, pontos batidos e a comparação com o período anterior. É a rota que a tela inicial do painel usa.
Aceita os mesmos filtros de GET /dashboard (period, from, to, scheduleId, companyId). Os blocos são calculados em paralelo no servidor, então esta chamada custa menos que as rotas separadas somadas.
previousKpissão os indicadores da janela imediatamente anterior, do mesmo tamanho, epreviousLabeldiz qual é. É o que permite mostrar "↑ 12% em relação ao período anterior".periodLabelé o nome do período para o título, como o nome do mês.- Os pontos vêm limitados a 500 no período, o bastante para um mês.
Pede a permissão de ver o painel.
Parâmetros
periodQuery · stringAtalho de período: `today` (hoje), `week` (últimos 7 dias) ou `period` (datas de `from` e `to`). Sem ele, vale o mês corrente.fromQuery · stringInício do período (`AAAA-MM-DD`).toQuery · stringFim do período (`AAAA-MM-DD`).scheduleIdQuery · stringMostra só uma escala.companyIdQuery · stringMostra só uma empresa cadastrada (o seletor do topo do painel).
Respostas
200 · Indicadores, seções, plantões, escalas, pontos e a comparação com o período anterior.
checkinsobject[] · Os registros de ponto.checkins[].addressstring · Endereço.checkins[].biometrystring · Resultado da biometria.checkins[].checkinstring · Entrada.checkins[].checkoutstring · Saída.checkins[].coordinatorstring · Coordenador responsável pela jornada.checkins[].crmstring · Número do CRM.checkins[].crmStatusstring · Situação do CRM no conselho, por extenso.checkins[].datestring · Data.checkins[].distanceMetersinteger · Distância, em metros, entre a batida e o local da escala.checkins[].doctorNamestring · Nome do médico.checkins[].exceptionReasonstring · Motivo da exceção.checkins[].exemptboolean · O médico é isento de ponto; sem registro, não é pendência.checkins[].geofenceRadiusMetersinteger · Raio, em metros, dentro do qual o ponto vale.checkins[].idstring · Identificador do registro.checkins[].lateMinutesinteger · Minutos de atraso na entrada.checkins[].paidAmountCentsinteger · Valor pago, em centavos.checkins[].paidAtstring · Quando foi pago.checkins[].paidBystring · Quem registrou o pagamento.checkins[].paymentTermstring · Prazo de pagamento: à vista ou a prazo.checkins[].punchLatnumber · Latitude de onde o médico bateu o ponto.checkins[].punchLngnumber · Longitude de onde o médico bateu o ponto.checkins[].scaleNamestring · Nome da escala.checkins[].scheduleLatnumber · Latitude do local da escala.checkins[].scheduleLngnumber · Longitude do local da escala.checkins[].sectorstring · Setor.checkins[].shiftstring · Turno.checkins[].shiftIdstring · Identificador do plantão.checkins[].shiftOriginstring · Origem do plantão:manual(avulso, pago na hora) ourule(da escala fixa, pago pela folha).checkins[].shiftTypestring · Tipo de plantão.checkins[].sourcestring · Origem.checkins[].specialtystring · Especialidade.checkins[].validatedAtstring · Quando foi validado.checkins[].validatedBystring · Quem validou; ausente enquanto ninguém validou.checkins[].valueCentsinteger · Valor, em centavos.checkins[].windowstring · Janela do plantão (início e fim), em texto.kpisobject · Indicadores do período.kpis.activeAdvancesCentsinteger · Antecipações em aberto, em centavos.kpis.advancesInMonthinteger · Antecipações no mês.kpis.checkinsInMonthinteger · Pontos batidos no mês.kpis.closesInDaysinteger · Dias até o fechamento.kpis.exposurePctnumber · Exposição em antecipações, em porcentagem.kpis.lateCheckinsinteger · Entradas com atraso.kpis.liveNowinteger · Plantões acontecendo agora.kpis.marginPctnumber · Margem, em porcentagem.kpis.payableCentsinteger · Valor a pagar, em centavos.kpis.payableDoctorsinteger · Médicos a pagar.kpis.receivableCentsinteger · Valor a receber, em centavos.kpis.shiftsInMonthinteger · Plantões no mês.periodLabelstring · Nome do período, para o título da tela.postsobject[] · As escalas, com a regra e os plantões do período.posts[].attendanceTypestring · Tipo de atendimento.posts[].cepstring · CEP, só dígitos.posts[].citystring · Cidade.posts[].complementstring · Complemento.posts[].contractTemplateIdstring · Identificador do modelo de contrato que define o valor do plantão.posts[].contractTemplateNamestring · Nome do modelo de contrato.posts[].coordinatorstring · Coordenador responsável pela jornada.posts[].diasSemanainteger[] · Dias da semana da escala fixa: 0 é domingo e 6 é sábado. Vem sempre, vazio quando a escala não é fixa.posts[].distribuicaostring: auto | vazio | manual · Como os médicos entram nos plantões que a escala gera:auto(o sistema distribui o time pela folga),vazio(plantões sem médico) oumanual(o gestor escolhe por dia).posts[].districtstring · Bairro.posts[].doctorsobject[] · Os médicos.posts[].doctors[].crmstring · Número do CRM.posts[].doctors[].idstring · Identificador do registro.posts[].doctors[].namestring · Nome.posts[].escalistastring · Escalista responsável pela jornada.posts[].geofenceRadiusMetersinteger · Raio, em metros, dentro do qual o ponto vale.posts[].hourlyRateCentsinteger · Valor da hora, em centavos.posts[].idstring · Identificador do registro.posts[].latitudenumber · Latitude do local da escala.posts[].longitudenumber · Longitude.posts[].medicosPropriosboolean · A jornada tem time próprio, em vez de usar o da escala.posts[].numberstring · Número.posts[].scaleNamestring · Nome da escala.posts[].scheduleIdstring · Identificador da escala.posts[].scheduleNamestring · Nome da escala.posts[].sectorstring · Setor.posts[].sectorIdstring · Identificador do setor.posts[].shiftstring · Turno.posts[].shiftTypeIdstring · Identificador do tipo de plantão.posts[].shiftsobject[] · Os plantões.posts[].shifts[].checkInstring · Horário da entrada.posts[].shifts[].checkInIdstring · Identificador do registro de ponto; ausente quando não há ponto.posts[].shifts[].checkOutstring · Horário da saída.posts[].shifts[].coordinatorstring · Coordenador responsável pela jornada.posts[].shifts[].datestring · Data.posts[].shifts[].doctorNamestring · Nome do médico.posts[].shifts[].durationHoursnumber · Duração, em horas.posts[].shifts[].endsAtstring · Fim.posts[].shifts[].idstring · Identificador do registro.posts[].shifts[].lateMinutesinteger · Minutos de atraso na entrada.posts[].shifts[].origemstring · Origem do plantão:rule(da escala fixa) oumanual(avulso).posts[].shifts[].pendingReleaseboolean · Há pedido de liberação da vaga aguardando a coordenação.posts[].shifts[].releasedBystring · Quem da coordenação liberou a batida fora da regra, quando houve pedido aprovado.posts[].shifts[].companyConfirmedAtstring · Quando a empresa escalou o médico atual do plantão.posts[].shifts[].doctorConfirmedAtstring · Quando o médico confirmou o plantão pelo aplicativo; ausente enquanto não confirmou.posts[].shifts[].paidAtstring · Quando o plantão foi pago na hora (dinheiro no local).posts[].shifts[].paidAmountCentsinteger · Valor pago na hora, em centavos.posts[].shifts[].addressstring · Endereço do posto (só na agenda do médico).posts[].shifts[].latnumber · Latitude do posto (só na agenda do médico).posts[].shifts[].lngnumber · Longitude do posto (só na agenda do médico).posts[].shifts[].paidBystring · Quem registrou o pagamento na hora.posts[].shifts[].punchLatnumber · Latitude de onde o médico bateu o ponto.posts[].shifts[].punchLngnumber · Longitude de onde o médico bateu o ponto.posts[].shifts[].punchOriginstring · Como o ponto entrou: batido pelo médico ou lançado pela coordenação.posts[].shifts[].scaleNamestring · Nome da escala.posts[].shifts[].sectorstring · Setor.posts[].shifts[].shiftstring · Turno.posts[].shifts[].specialtystring · Especialidade.posts[].shifts[].startsAtstring · Início.posts[].shifts[].statusstring · Situação.posts[].shifts[].validatedAtstring · Quando foi validado.posts[].shifts[].validatedBystring · Quem validou; ausente enquanto ninguém validou.posts[].shifts[].valueCentsinteger · Valor, em centavos.posts[].shifts[].windowstring · Janela do plantão (início e fim), em texto.posts[].specialtystring · Especialidade.posts[].specialtyIdstring · Identificador da especialidade.posts[].statestring · Estado.posts[].statusstring · Situação.posts[].streetstring · Logradouro.posts[].swapPolicystring · Política de troca da escala.posts[].totalCentsinteger · Valor total, em centavos.posts[].validoAtestring · Fim da vigência (AAAA-MM-DD). A escala vale no máximo 1 ano.posts[].validoDestring · Início da vigência (AAAA-MM-DD). Obrigatório na escala fixa.posts[].windowstring · Janela do plantão (início e fim), em texto.previousKpisobject · Indicadores do período anterior, do mesmo tamanho.previousKpis.activeAdvancesCentsinteger · Antecipações em aberto, em centavos.previousKpis.advancesInMonthinteger · Antecipações no mês.previousKpis.checkinsInMonthinteger · Pontos batidos no mês.previousKpis.closesInDaysinteger · Dias até o fechamento.previousKpis.exposurePctnumber · Exposição em antecipações, em porcentagem.previousKpis.lateCheckinsinteger · Entradas com atraso.previousKpis.liveNowinteger · Plantões acontecendo agora.previousKpis.marginPctnumber · Margem, em porcentagem.previousKpis.payableCentsinteger · Valor a pagar, em centavos.previousKpis.payableDoctorsinteger · Médicos a pagar.previousKpis.receivableCentsinteger · Valor a receber, em centavos.previousKpis.shiftsInMonthinteger · Plantões no mês.previousLabelstring · Nome do período anterior usado na comparação.schedulesobject[] · As escalas.schedules[].idstring · Identificador do registro.schedules[].namestring · Nome.schedules[].postsobject[] · As escalas, com a regra e os plantões do período.schedules[].posts[].idstring · Identificador do registro.schedules[].posts[].labelstring · Nome exibido.schedules[].posts[].shiftTypestring · Tipo de plantão.schedules[].posts[].shiftTypeIdstring · Identificador do tipo de plantão.sectionsobject · Blocos detalhados do painel.sections.advancesobject[] · Os pedidos de antecipação.sections.advances[].doctorNamestring · Nome do médico.sections.advances[].feePctnumber · Taxa, em porcentagem.sections.advances[].idstring · Identificador do registro.sections.advances[].netAmountCentsinteger · Valor líquido, em centavos.sections.advances[].shiftsDoneinteger · Plantões realizados.sections.advances[].statusstring · Situação.sections.advances[].whenstring · Quando.sections.cashflowobject[] · Fluxo de caixa.sections.cashflow[].monthstring · Mês.sections.cashflow[].payableCentsinteger · Valor a pagar, em centavos.sections.cashflow[].projectedboolean · O mês ainda não fechou: o número é projeção.sections.cashflow[].receivableCentsinteger · Valor a receber, em centavos.sections.checkinByDoctorobject[] · Ponto por médico.sections.checkinByDoctor[].labelstring · Nome exibido.sections.checkinByDoctor[].lateinteger · Plantões com atraso.sections.checkinByDoctor[].missinginteger · Plantões sem ponto.sections.checkinByDoctor[].onTimeinteger · Plantões no horário.sections.checkinByScheduleobject[] · Ponto por escala.sections.checkinBySchedule[].labelstring · Nome exibido.sections.checkinBySchedule[].lateinteger · Plantões com atraso.sections.checkinBySchedule[].missinginteger · Plantões sem ponto.sections.checkinBySchedule[].onTimeinteger · Plantões no horário.sections.pendenciesobject[] · Pendências.sections.pendencies[].countinteger · Quantidade.sections.pendencies[].detailstring · Detalhe do evento.sections.pendencies[].hrefstring · Caminho da tela onde a pessoa resolve o assunto.sections.pendencies[].idstring · Identificador do registro.sections.pendencies[].labelstring · Nome exibido.sections.pendencies[].severitystring · Gravidade.sections.shiftsobject[] · Os plantões.sections.shifts[].currentinteger · É o atual.sections.shifts[].dayinteger · Dia.sections.shifts[].previousinteger · Valor do período anterior.
Corpo de exemplo
{
"checkins": [
{
"address": "texto",
"biometry": "texto",
"checkin": "texto",
"checkout": "texto",
"coordinator": "texto",
"crm": "texto",
"crmStatus": "texto",
"date": "texto",
"distanceMeters": 1,
"doctorName": "texto",
"exceptionReason": "texto",
"exempt": true,
"geofenceRadiusMeters": 1,
"id": "3f0c2a5e-9b1d-4c7e-8a21-6d0f5b7ca91e",
"lateMinutes": 1,
"paidAmountCents": 150000,
"paidAt": "texto",
"paidBy": "texto",
"paymentTerm": "texto",
"punchLat": 1,
"punchLng": 1,
"scaleName": "texto",
"scheduleLat": 1,
"scheduleLng": 1,
"sector": "texto",
"shift": "texto",
"shiftId": "3f0c2a5e-9b1d-4c7e-8a21-6d0f5b7ca91e",
"shiftOrigin": "texto",
"shiftType": "texto",
"source": "texto",
"specialty": "texto",
"validatedAt": "texto",
"validatedBy": "texto",
"valueCents": 150000,
"window": "texto"
}
],
"kpis": {
"activeAdvancesCents": 150000,
"advancesInMonth": 1,
"checkinsInMonth": 1,
"closesInDays": 1,
"exposurePct": 1,
"lateCheckins": 1,
"liveNow": 1,
"marginPct": 1,
"payableCents": 150000,
"payableDoctors": 1,
"receivableCents": 150000,
"shiftsInMonth": 1
},
"periodLabel": "texto",
"posts": [
{
"attendanceType": "texto",
"cep": "texto",
"city": "texto",
"complement": "texto",
"contractTemplateId": "3f0c2a5e-9b1d-4c7e-8a21-6d0f5b7ca91e",
"contractTemplateName": "texto",
"coordinator": "texto",
"diasSemana": [
null
],
"distribuicao": "auto",
"district": "texto",
"doctors": [
{}
],
"escalista": "texto",
"geofenceRadiusMeters": 1,
"hourlyRateCents": 150000,
"id": "3f0c2a5e-9b1d-4c7e-8a21-6d0f5b7ca91e",
"latitude": 1,
"longitude": 1,
"medicosProprios": true,
"number": "texto",
"scaleName": "texto",
"scheduleId": "3f0c2a5e-9b1d-4c7e-8a21-6d0f5b7ca91e",
"scheduleName": "texto",
"sector": "texto",
"sectorId": "3f0c2a5e-9b1d-4c7e-8a21-6d0f5b7ca91e",
"shift": "texto",
"shiftTypeId": "3f0c2a5e-9b1d-4c7e-8a21-6d0f5b7ca91e",
"shifts": [
{}
],
"specialty": "texto",
"specialtyId": "3f0c2a5e-9b1d-4c7e-8a21-6d0f5b7ca91e",
"state": "texto",
"status": "texto",
"street": "texto",
"swapPolicy": "texto",
"totalCents": 150000,
"validoAte": "texto",
"validoDe": "texto",
"window": "texto"
}
],
"previousKpis": {
"activeAdvancesCents": 150000,
"advancesInMonth": 1,
"checkinsInMonth": 1,
"closesInDays": 1,
"exposurePct": 1,
"lateCheckins": 1,
"liveNow": 1,
"marginPct": 1,
"payableCents": 150000,
"payableDoctors": 1,
"receivableCents": 150000,
"shiftsInMonth": 1
},
"previousLabel": "texto",
"schedules": [
{
"id": "3f0c2a5e-9b1d-4c7e-8a21-6d0f5b7ca91e",
"name": "texto",
"posts": [
{}
]
}
],
"sections": {
"advances": [
{
"doctorName": null,
"feePct": null,
"id": null,
"netAmountCents": null,
"shiftsDone": null,
"status": null,
"when": null
}
],
"cashflow": [
{
"month": null,
"payableCents": null,
"projected": null,
"receivableCents": null
}
],
"checkinByDoctor": [
{
"label": null,
"late": null,
"missing": null,
"onTime": null
}
],
"checkinBySchedule": [
{
"label": null,
"late": null,
"missing": null,
"onTime": null
}
],
"pendencies": [
{
"count": null,
"detail": null,
"href": null,
"id": null,
"label": null,
"severity": null
}
],
"shifts": [
{
"current": null,
"day": null,
"previous": null
}
]
}
}