analytics

Average path

Changed on

Returns all average path metrics

get/api/analytics/average-path

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/average-path
  • Auth: HTTP bearer

Query parameters

as_ofstring date nullable

Reference date (YYYY-MM-DD). If omitted, today is used. Used for point-in-time report.

from_datestring date nullable

First completed session on or after this date (Europe/Rome).

to_datestring date nullable

First completed session on or before this date; follow-up still runs to as_of/today.

Response

Successful Response

from_datestring date nullable
to_datestring date nullable
as_of_atstring date-time nullable
started_patientsobject

Changes

  • c612195c91c3Revision changes
    • info

      added the new optional query request parameter from_date

    • info

      added the new optional query request parameter to_date

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 5c57d02d889cRevision changes
    • breaking

      the response property // became optional for the status

    • breaking

      response property average_monthly_sessions/items/average_sessions_per_patient list-of-types was widened by adding types null to media type application/json of response 200

    • info

      added the optional property to the response with the status