Public: Opportunities

List page opportunities

Pages Iterant thinks are worth building or improving, ranked by priority score.

Each row carries a ref: a stable, human-readable handle derived from the title. It is what the detail route takes. Refs are not constructible: use one that came back from here.

status is the derived display status, which folds in the state of any page the opportunity produced: ready/enriched/discovered are open work, drafting/drafted/publishing are in flight, published/dismissed/superseded are done.

Capped and paginated; the note says how to narrow when rows are hidden. Filtering by status walks rows, so it stops after the 500 highest-priority opportunities; past that bound total is null rather than a count of what happened to fit inside it.

get/api/v1/public/brands/{brandSlug}/page-opportunities/

Request

  • Base URL: https://api.iterant.ai
  • URL: https://api.iterant.ai/api/v1/public/brands/{brandSlug}/page-opportunities/
  • Auth: HTTP bearer

Path parameters

brandSlugstring required

Query parameters

archetype'comparison' | 'standard'
intent'commercial' | 'informational' | 'navigational' | 'transactional'
limitstring

1-50, default 20.

offsetstring

Rows to skip.

responseFormat'concise' | 'detailed'

How much to return. concise (the default) omits long-form text: briefs, outlines, evidence, passage excerpts, per-dimension breakdowns. detailed includes it and costs several times the tokens.

role'pillar' | 'spoke' | 'standalone'
status'backlog' | 'discovered' | 'dismissed' | 'drafted' | 'drafting' | 'enriched' | 'failed_generation' | 'publish_failed' | 'published' | 'publishing' | 'ready' | 'republish_pending' | 'scheduled' | 'superseded'

Only this display status.

surface'dual' | 'geo_primary' | 'seo_primary'

Response

totalinteger nullable required

Rows matching the query, before limit and offset. Null when a status filter outran the scan bound and the true count is not knowable. note says so.

offsetinteger required

Rows skipped. Echoed back so a caller can page without bookkeeping.

limitinteger required

Cap actually applied, which may be lower than the one requested.

notestring required

How to narrow, when the cap hid rows. Empty when the response is the whole answer.

Changes

No recorded changes to this operation across all 1 revision of this API.