Skip to main content

GET Agendamentos por Status

Contar agendamentos por status. Retorna a contagem de agendamentos agrupados por status (agendado, confirmado, cancelado, finalizado, faltou). Aceita query param period=today|week|month.

Autenticação necessária

Envie o header Authorization: Bearer {accessToken} (token de usuário) ou x-api-key: {apiKey} (integrações). Veja Autenticação.

Sem permissão específica

Não exige @CheckPermissions — basta estar autenticado.


Endpoint​

GET https://api-dev.imagemais.com.br/api/dashboard/appointments-count-by-status

Parâmetros de Query​

NomeTipoObrigatórioValores válidosDescrição
periodstring❌—Período do indicador: today, week ou month (padrão: today)

Requisição​

curl -X 'GET' \
'https://api-dev.imagemais.com.br/api/dashboard/appointments-count-by-status' \
-H 'accept: application/json' \
-H 'Authorization: Bearer {accessToken}'

Respostas​

200 Sucesso​

{
"data": {
"agendado": 0,
"confirmado": 0,
"cancelado": 0,
"finalizado": 0,
"faltou": 0
}
}

503 Serviço indisponível​

{
"message": "Dados temporariamente indisponíveis",
"error": "Service Unavailable",
"statusCode": 503
}