Sign in
code-health

Refactoring Opportunities

One page of the ranked queue, with its facets and rollup.

facets count the whole set at the requested status rather than the page, because they are the chips a person clicks to widen the filter. An unrecognized filter value is reported in ignored_arguments rather than rejected, so a stale bookmark degrades to the default view.

get/snapshots/{snapshot_id}/refactoring/opportunities

Path parameters

snapshot_idstring required

Query parameters

refactoring_typestring nullable

Lead refactoring type, or several comma-separated.

Lead refactoring type, or several comma-separated.

statusstring

open | acknowledged | resolved | false_positive

open | acknowledged | resolved | false_positive

confidencestring nullable

low | medium | high

low | medium | high

effortstring nullable

S | M | L | XL

S | M | L | XL

file_pathstring nullable

One repo-relative path.

One repo-relative path.

searchstring nullable

Substring of a file path.

Substring of a file path.

mechanicalboolean

Only sets with a mechanical step.

Only sets with a mechanical step.

viewstring

canonical | file_spread | diversified

canonical | file_spread | diversified

orderstring nullable

queue | rank | health | effort | file

queue | rank | health | effort | file

step_previewinteger

Steps inlined per row.

Steps inlined per row.

limitinteger
offsetinteger

Response

Successful Response

object required

Changes