Iterant is in early access. These docs describe the product as it works today.
Iterant Docs
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/

Authorization

tenantApiKeyAuth
AuthorizationBearer <token>

In: header

Path Parameters

brandSlug*string

Query Parameters

archetype?string

Value in

  • "comparison"
  • "standard"
intent?string

Value in

  • "commercial"
  • "informational"
  • "navigational"
  • "transactional"
limit?string

1-50, default 20.

offset?string

Rows to skip.

responseFormat?string

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.

Default"concise"

Value in

  • "concise"
  • "detailed"
role?string

Value in

  • "pillar"
  • "spoke"
  • "standalone"
status?string

Only this display status.

Value in

  • "approved"
  • "discovered"
  • "dismissed"
  • "drafted"
  • "drafting"
  • "enriched"
  • "failed_generation"
  • "in_review"
  • "publish_failed"
  • "published"
  • "publishing"
  • "ready"
  • "republish_pending"
  • "scheduled"
  • "superseded"
surface?string

Value in

  • "dual"
  • "geo_primary"
  • "seo_primary"

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/public/brands/string/page-opportunities/"
{  "items": [    {      "ref": "phoenix-observability-alternatives-llm-tracing-testing-0f1c2d3e",      "title": "Phoenix Observability Alternatives: LLM Tracing & Testing",      "status": "ready",      "intent": "commercial",      "surface": "geo_primary",      "priorityScore": 90,      "primaryKeyword": "Phoenix alternatives",      "searchVolumeMonthly": 40    }  ],  "total": 196,  "offset": 0,  "limit": 20,  "note": "Showing 20 of 196 (offset 0). Narrow by status, intent, surface, role or archetype, or pass offset=20 for the next page."}

Last updated on