Practice Observations

List observations for current user

Changed on

Paginated observations for the authenticated developer with optional filters

get/workspaces/{workspaceSlug}/practices/observations

Request

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

Path parameters

workspaceSlugstring required

Workspace slug

Query parameters

practiceSlugstring

Filter by practice slug

groupSlugstring

Filter by the practice group the observed practice belongs to

outcome'MET' | 'NOT_MET' | 'NOT_APPLICABLE' | 'UNDETERMINED'

Filter by review outcome

artifactKindsstring[]

Only observations on these kinds of reviewed work, e.g. scm.pull_request (repeatable)

artifactKindstring

Exact reviewed-work kind; requires artifactId, e.g. scm.pull_request or scm.issue

artifactIdinteger

Exact reviewed-work ID; requires artifactKind

severitiesstring[]

Only observations with these severities (repeatable); omit for all

displayableOnlyboolean

Drop NOT_APPLICABLE rows — only observations where the practice actually applied

sort'DATE' | 'SEVERITY'

Feed ordering: DATE (default) or SEVERITY (most severe first, ties newest-first)

direction'ASC' | 'DESC'

Ordering direction: for DATE newest/oldest first, for SEVERITY most/least severe first

pageinteger

Zero-based page

sizeinteger

Page size from 1 to 100

Response

Paginated observations returned

emptyboolean
firstboolean
lastboolean
numberinteger
numberOfElementsinteger
sizeinteger
totalElementsinteger
totalPagesinteger

Changes

  • 9662502b2cc4Revision 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]$

  • 91e1986ff53bRevision changes
    • breaking

      removed the required property // from the response with the status

    • warning

      deleted the query request parameter assessmentStatus

    • warning

      deleted the query request parameter presence

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • info

      added the new optional query request parameter outcome

    • info

      the response optional property // became not read-only for the status

    • info

      the response property // became required for the status

    • info

      removed the NEGATIVE enum value from the // response property for the response status

    • info

      removed the POSITIVE enum value from the // response property for the response status