Practice Observations

Per-practice summary for current user

Changed on

Aggregated observation counts per practice for dashboard cards

get/workspaces/{workspaceSlug}/practices/observations/summary

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /workspaces/{workspaceSlug}/practices/observations/summary
  • Auth: HTTP bearer

Path parameters

workspaceSlugstring required

Workspace slug

Response

Practice summaries returned

lastObservedAtstring date-time

Timestamp of most recent observation

metinteger required

Number of MET observations

notApplicableinteger required
notMetinteger required

Number of NOT_MET observations

practiceNamestring required

Practice name

practiceSlugstring required

Practice slug

totalObservationsinteger required

Total number of observations

undeterminedinteger required

Changes

    • breaking

      for the path request parameter workspaceSlug, the minLength was increased from 0 to 3

    • warning

      for the path request parameter workspaceSlug, the maxLength was set to 51

    • warning

      changed the pattern of the path request parameter workspaceSlug from ^[a-z0-9][a-z0-9-]{2,50}$ to ^(?!.*--)[a-z0-9][a-z0-9-]{1,49}[a-z0-9]$

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status