citlyze docs

Page Audits

Stored page audits with per-factor findings.

GET /api/v1/page-audits returns stored page audits, newest first: one row per audited page with its total score and per-category scores. GET /api/v1/page-audit-findings returns the factor-level findings behind one audit.

Audits are created in the product (the Page audits section); the API is read-only, so an exposed key can never spend audit credits.

Page audit filters

ParameterMeaning
audit_idFetch one audit.
normalized_urlAll audits of one URL (the history behind score diffs).
statusrunning, completed, or failed.
modeurl (single page) or domain (from a domain set).
audit_set_idAudits spawned by one saved set.
bot_identityThe crawler identity the audit ran as.
since / untilBounds for started_at (ISO timestamp).

Finding filters

ParameterMeaning
audit_idThe audit whose findings to list.
category_idOne of the eight audit categories.
statuspass, warn, fail, or info.

Standard parameters (limit, offset, format=csv) work as described in Pagination, filtering, and errors.

Key fields

  • total_score: 0-100, weighted across the categories available for that run. Categories that could not run are excluded from the weighting, never counted as zero.
  • category_scores_json: per-category score, effective weight, and an unavailable_reason when a category could not run.
  • engine_version: the scoring engine revision. Only compare scores that share a version.
  • page_type: the rule-based page classification that adjusted category weights.
  • Findings carry factor_id, status, points, weight, structured evidence_json, and a fix_hint_id mapping to the guidance shown in the product.

Example

curl -H "Authorization: Bearer $AEO_API_KEY" \
  "https://app.citlyze.com/api/v1/page-audits?normalized_url=https://example.com/pricing"

Use these resources to chart audit scores over time in BI tools, or to pull fail-status findings into your own issue tracker.

On this page