Docs Sign inGet started
API reference · Changes

List opportunities

Opportunities with evidence and measured impact.

GET/api/v1/domains/{domain}/opportunities

Path parameters

domainstringRequired

The domain's host, like acme.example, or its ID. List them with List domains.

Query parameters

statusstringdefault open

open, in_progress, shipped or all.

openin_progressshippedall

Returns

opportunities[].kindstring

owned (publish on your site) or earned (get cited elsewhere).

opportunities[].prioritynumber

Share of recent answers it could affect.

opportunities[].priority_labelstring

high, medium or low.

opportunities[].statusstring

open, in_progress, shipped or dismissed.

opportunities[].evidenceobject

The prompts, answers and sources behind it.

opportunities[].impactobject or null

For shipped ones: visibility before and after on its prompts, and a verdict of waiting, early, up, down or none.

Every response includes the domain and the filters that were applied. Errors use the standard error object.