Sign in
analytics

Paginated registration activity behind a dashboard metric

Changed on
get/api/analytics/dashboard/registration-activity

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/registration-activity
  • Auth: HTTP bearer

Query parameters

metric'new_registered_patients' | 'completed_initial_questionnaires' | 'incomplete_initial_questionnaires' | 'free_call_bookings' | 'intro_call_purchases' | 'initial_questionnaire_completion_rate_pct' | 'free_call_booking_rate_pct' | 'intro_call_purchase_rate_pct' required
searchstring nullable
patient_idstring uuid nullable
period'today' | 'yesterday' | 'week' | 'month' | 'this_month' | 'custom'
from_datestring date nullable
to_datestring date nullable
per_pageinteger
pageinteger

Response

Successful Response

metric'new_registered_patients' | 'completed_initial_questionnaires' | 'incomplete_initial_questionnaires' | 'free_call_bookings' | 'intro_call_purchases' | 'initial_questionnaire_completion_rate_pct' | 'free_call_booking_rate_pct' | 'intro_call_purchase_rate_pct' required
totalinteger required
per_pageinteger required
pageinteger required

Changes

  • 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

  • 6afa01417695Revision changes
    • ○

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

    • ○

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

    • ○

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

    • ○

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

    • ○

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