Skip to main content
GET
Get Opportunity Type Detail

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

brand_id
integer
required
best_practice_id
string
required

Query Parameters

state
enum<string>
default:all

Restrict the affected-page window to this pipeline state.

Available options:
all,
pending,
reviewed,
staged,
deployed
limit
integer
default:25
Required range: 1 <= x <= 100
offset
integer
default:0
Required range: x >= 0

Response

Successful Response

One opportunity type's detail view: catalog header, per-state counts, and a page of its affected pages. The header and every count span the WHOLE type (independent of the state filter and pagination); only pages is the sliced, state-filtered window that carries chunk diffs.

best_practice_id
string
required
name
string
required
checking
string
required
bucket
enum<string>
required
Available options:
hygiene,
transformation,
enrichment
action
string
required
site_impact_pp
number | null
required
metric
enum<string>
required
Available options:
citeability,
retrievability
page_count
integer
required
pending_count
integer
required
reviewed_count
integer
required
staged_count
integer
required
deployed_count
integer
required
offset
integer
required
limit
integer
required
filtered_total
integer
required
pages
OpportunityTypePageReview · object[]
required
site_impact_unavailable_reason
enum<string> | null
Available options:
not_in_scored_run,
no_scored_run