Iterant is in early access. These docs describe the product as it works today.
Iterant Docs
reports

Get a page (or brand-wide) report

How a page is performing, projected to the `metrics` you ask for. Each one is a separate upstream read, so ask for what you need: - `score`: quality and citability grades plus the ranked priority fixes - `performance`: Search Console clicks/impressions/CTR/position and AI-assistant referral clicks by provider - `traffic`: visitor sessions and conversions from the signals mart - `conversions`: per-definition conversion counts - `anatomy`: which components get clicked and how far visitors scroll Every performance block carries a `state`: only `ok` means the numbers are real. `no_data`, `unconfigured` and `error` return null metrics. Report the state, never substitute zero. `traffic`, `conversions` and `anatomy` are sampling-weighted estimates and honour `window`. `performance` is snapshot-shaped: it reports the window the capture covered, which `window` does not change. Omit `urlPath` for a brand-wide roll-up.

GET
/api/v1/public/brands/{brandSlug}/reports/pages/

Authorization

tenantApiKeyAuth
AuthorizationBearer <token>

In: header

Path Parameters

brandSlug*string

Query Parameters

metrics?string

Comma-separated projections. Legal values: score, performance, traffic, conversions, anatomy. Defaults to score,performance.

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"
urlPath?string

Page route. Omit for a brand-wide roll-up.

window?string

Rolling window ending today.

Default"28d"

Value in

  • "28d"
  • "7d"
  • "90d"

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/reports/pages/"
{  "brandSlug": "orbital-labs",  "scope": {    "urlPath": "/pricing"  },  "window": "28d",  "score": {    "overall": 71,    "letterGrade": "C-",    "citability": {      "overall": 50,      "grade": "C"    }  },  "performance": {    "search": {      "state": "unconfigured",      "windowDays": null,      "effectiveThrough": null,      "metrics": null    },    "llmReferrals": {      "state": "no_data",      "windowDays": null,      "effectiveThrough": null,      "metrics": null    }  }}

Last updated on