Practice review trace

List work this workspace recorded something about

Changed on

Workspace admins only. Built from the signal ledger, so it includes work that was never reviewed — which is exactly what a listing derived from review runs cannot show. Most recently signalled first. A from/to window keeps the signals that occurred in it, so each row and its counts then describe that window.

get/workspaces/{workspaceSlug}/practices/trace

Request

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

Path parameters

workspaceSlugstring required

Workspace slug

Query parameters

pageinteger
sizeinteger
artifactKindstring

Restrict to one kind of work, e.g. scm.pull_request

artifactIdinteger

Restrict to one piece of work; requires artifactKind

fromstring date-time

Inclusive lower bound on when a signal occurred

tostring date-time

Exclusive upper bound on when a signal occurred

withoutReviewboolean

Only the work none of whose signals in the window started a review, which is the work somebody expected a review on and did not get one

Response

Paginated artifacts returned

Changes

  • 80ad90d36e50Revision changes
    • info

      added the new optional query request parameter artifactId

    • info

      added the new optional query request parameter from

    • info

      added the new optional query request parameter to

    • info

      added the new optional query request parameter withoutReview

    • info

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

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