Sign in
analytics

Paginated patients behind a dashboard metric

Changed on
get/api/analytics/dashboard/patients

Request

  • Base URL: https://api.corabea.it (the document declares no server; this is the origin it was published from)
  • URL: https://api.corabea.it/api/analytics/dashboard/patients
  • Auth: HTTP bearer

Query parameters

metric'new_entries' | 'entered_to_rebook' | 'abandonments' | 'abandonment_risk' | 'frequency_not_respected' | 'appointments_to_reschedule' required
searchstring nullable
path'PSICOLOGO' | 'NUTRIZIONISTA'

Operator profession constants.

operator_idstring uuid nullable
sort_dir'asc' | 'desc' nullable

Only for metric=entered_to_rebook: order by when the path entered the state.

coordinator_idstring uuid nullable

Only patients followed by this coordinator's experts.

entered_in_periodboolean nullable

Only for metric=entered_to_rebook: keep the paths that entered the state within the period.

period'today' | 'yesterday' | 'week' | 'month' | 'this_month' | 'custom'
from_datestring date nullable
to_datestring date nullable
per_pageinteger
pageinteger

Response

Successful Response

metric'new_entries' | 'entered_to_rebook' | 'abandonments' | 'abandonment_risk' | 'frequency_not_respected' | 'appointments_to_reschedule' required
sort_dir'asc' | 'desc' nullable
coordinator_idstring uuid nullable
entered_in_periodboolean nullable
totalinteger required
per_pageinteger required
pageinteger required

Changes

  • 6108ff351838Revision changes
    • ●

      added the new path_monitoring enum value to the //// response property for the response status

    • ○

      added the optional property //// to the response with the status

    • ○

      added the optional property //// to the response with the status

  • f23730d7b735Revision changes
    • ●

      added the new this_month enum value to the / response property for the response status

    • ○

      added the new enum value this_month to the query request parameter period