All HTML Pages

GET

/api/v1/audit_pages

curl --request GET \
  --url 'https://sitechecker.pro/api/v1/audit_pages?project_id=12345&segment_id=all_pages&order_by=url&fields=url&limit=50&offset=0' \
  --header 'Authorization: Bearer <token>'

• Production

Returns crawled HTML pages for a project or segment, including each page’s technical audit data, issue counts, and connected GSC or GA4 metrics when available.

Authorizations

• bearerAuth

Parameters

Query Parameters

project_id

required

integer

Example

12345

Project ID.

segment_id

string

Example

all_pages

Optional segment scope filter.

issue_id

integer

Scope pages to those affected by this issue (filter) id.

url

string

Substring URL search (e.g. “blog” returns pages whose URL contains it).

url_in

string

Exact-URL match list (comma-separated). Returns only the listed pages. Takes precedence over url.

order_by

string

Allowed values: url page_weight page_score status_code indexability title h1 description word_count page_depth charset_type content_type character_count text_length h1_count title_count description_count body_count canonicals_count critical_count warning_count opportunity_count notice_count incoming_links_count internal_links_count external_links_count unique_internal_links_count unique_external_links_count robots_txt_status follow_status nofollow_status noarchive_status nosnippet_status blocked_by_robots_txt added_from_sitemap

Sort as “_asc” or “_desc”, e.g. page_weight_desc.

fields

string

Allowed values: url page_score page_weight status_code indexability canonical title h1 word_count issue_found_date critical_count warning_count opportunity_count notice_count incoming_links_count internal_links_count external_links_count ranked_keywords impressions clicks ctr average_position sessions avg_session_duration key_events session_key_event_rate description content_type charset_type body_count character_count description_count h1_count text_length title_count page_depth robots_txt_status follow_status nofollow_status noarchive_status nosnippet_status blocked_by_robots_txt added_from_sitemap canonicals_count unique_internal_links_count unique_external_links_count bounce_rate potential_clicks potential_rank potential_key_events issues

Comma-separated field projection. Omit for defaults. Use “issues” for the compact per-page issue list (adds a summary lookup).

limit

integer

default: 50 >= 1 <= 100

Page size.

offset

integer

0

Pagination offset.

Responses

200

Paginated pages

Media typeapplication/json

object

data

Array<object>

Default fields are listed below. Pass fields to project a subset or to add optional fields (description, content_type, charset_type, count, page_depth, robots/follow/nofollow/noarchive/nosnippet/blocked_by_robots_txt, added_from_sitemap, unique_links_count, bounce_rate, potential_clicks, potential_rank, potential_key_events) or fields=issues for the compact issue list. GSC/GA4 fields are null unless the project has Search Console / GA4 connected.

object

url

Page URL. Returned as part of the pages list.

string

nullable

page_score

Page-level audit score.

integer

nullable

page_weight

Page importance/weight.

number format: float

nullable

status_code

HTTP status code.

integer

nullable

indexability

Whether the page is indexable.

boolean

nullable

title

Page title.

string

nullable

h1

Main H1.

string

nullable

word_count

Words count on the page.

integer

nullable

issue_found_date

Relevant when the endpoint is filtered by issue_id.

string format: date-time

nullable

critical_count

Number of critical issues found on this page.

integer

nullable

warning_count

Number of warning issues found on this page.

integer

nullable

opportunity_count

Number of opportunity issues found on this page.

integer

nullable

notice_count

Number of notice issues found on this page.

integer

nullable

incoming_links_count

Internal incoming links count.

integer

nullable

internal_links_count

Internal outgoing links count.

integer

nullable

external_links_count

External outgoing links count.

integer

nullable

ranked_keywords

GSC/Search Metrics ranked keywords count if connected.

integer

nullable

impressions

GSC impressions if connected.

integer

nullable

clicks

GSC clicks if connected.

integer

nullable

ctr

GSC CTR if connected.

number format: float

nullable

average_position

GSC average position if connected.

integer

nullable

sessions

GA4 sessions if connected.

integer

nullable

avg_session_duration

GA4 average session duration if connected.

number format: float

nullable

key_events

GA4 key events/conversions if connected.

integer

nullable

session_key_event_rate

GA4 session key event rate if connected.

number format: float

nullable

meta

object

total

Reusable OpenAPI response schemas for the Public REST API: the error/meta envelope and one item schema per resource. Property names come from the Field registry so the documented contract and the runtime response shapes stay in lock-step.

integer

limit

integer

offset

integer

Example

{
  "data": [
    {
      "url": "https://example.com/page",
      "page_score": 75,
      "page_weight": 2.45,
      "status_code": 200
    }
  ],
  "meta": {
    "total": 137,
    "limit": 50,
    "offset": 0
  }
}

401

Missing or invalid API key

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: validation_error bad_request project_not_found segment_not_found forbidden crawl_in_progress not_found upstream_error unauthorized rate_limit_exceeded api_access_denied internal_error crawl_not_found invalid_date_range invalid_filter invalid_event_type keyword_not_found opportunity_not_found snapshot_unavailable gsc_not_connected ga4_not_connected site_audit_data_unavailable ga4_data_unavailable unsupported_filter unsupported_dimension segment_filter_unsupported unsupported_scope ai_overview_data_unavailable prompt_data_unavailable

message

required

string

Example

{
  "error": {
    "code": "unauthorized",
    "message": "Invalid or missing API key."
  }
}

403

No active API entitlement for the account, or the project belongs to another account

Media typeapplication/json

Returned as api_access_denied when the account has no active API entitlement, and as forbidden when the requested project belongs to another account.

object

error

required

object

code

required

string

Allowed values: validation_error bad_request project_not_found segment_not_found forbidden crawl_in_progress not_found upstream_error unauthorized rate_limit_exceeded api_access_denied internal_error crawl_not_found invalid_date_range invalid_filter invalid_event_type keyword_not_found opportunity_not_found snapshot_unavailable gsc_not_connected ga4_not_connected site_audit_data_unavailable ga4_data_unavailable unsupported_filter unsupported_dimension segment_filter_unsupported unsupported_scope ai_overview_data_unavailable prompt_data_unavailable

message

required

string

Example

{
  "error": {
    "code": "api_access_denied",
    "message": "API access is not available: the account has no active API entitlement."
  }
}

404

Project or segment not found

Media typeapplication/json

The exact missing resource is in error.code: project_not_found, segment_not_found, crawl_not_found, keyword_not_found, opportunity_not_found, snapshot_unavailable or not_found.

object

error

required

object

code

required

string

Allowed values: validation_error bad_request project_not_found segment_not_found forbidden crawl_in_progress not_found upstream_error unauthorized rate_limit_exceeded api_access_denied internal_error crawl_not_found invalid_date_range invalid_filter invalid_event_type keyword_not_found opportunity_not_found snapshot_unavailable gsc_not_connected ga4_not_connected site_audit_data_unavailable ga4_data_unavailable unsupported_filter unsupported_dimension segment_filter_unsupported unsupported_scope ai_overview_data_unavailable prompt_data_unavailable

message

required

string

Example

{
  "error": {
    "code": "project_not_found",
    "message": "Project not found."
  }
}

409

Crawling in progress (no audit data yet)

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: validation_error bad_request project_not_found segment_not_found forbidden crawl_in_progress not_found upstream_error unauthorized rate_limit_exceeded api_access_denied internal_error crawl_not_found invalid_date_range invalid_filter invalid_event_type keyword_not_found opportunity_not_found snapshot_unavailable gsc_not_connected ga4_not_connected site_audit_data_unavailable ga4_data_unavailable unsupported_filter unsupported_dimension segment_filter_unsupported unsupported_scope ai_overview_data_unavailable prompt_data_unavailable

message

required

string

Example

{
  "error": {
    "code": "crawl_in_progress",
    "message": "Crawling is in progress. No audit data is available yet."
  }
}

422

Validation error

Media typeapplication/json

Rejected query parameters. error.code is validation_error for parameter validation, or invalid_date_range / invalid_filter / invalid_event_type / unsupported_filter / unsupported_dimension / unsupported_scope / segment_filter_unsupported for module-specific rules.

object

error

required

object

code

required

string

Allowed values: validation_error bad_request project_not_found segment_not_found forbidden crawl_in_progress not_found upstream_error unauthorized rate_limit_exceeded api_access_denied internal_error crawl_not_found invalid_date_range invalid_filter invalid_event_type keyword_not_found opportunity_not_found snapshot_unavailable gsc_not_connected ga4_not_connected site_audit_data_unavailable ga4_data_unavailable unsupported_filter unsupported_dimension segment_filter_unsupported unsupported_scope ai_overview_data_unavailable prompt_data_unavailable

message

required

string

Example

{
  "error": {
    "code": "validation_error",
    "message": "project_id is required."
  }
}

429

Rate limit exceeded — retry after the interval in the Retry-After header

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: validation_error bad_request project_not_found segment_not_found forbidden crawl_in_progress not_found upstream_error unauthorized rate_limit_exceeded api_access_denied internal_error crawl_not_found invalid_date_range invalid_filter invalid_event_type keyword_not_found opportunity_not_found snapshot_unavailable gsc_not_connected ga4_not_connected site_audit_data_unavailable ga4_data_unavailable unsupported_filter unsupported_dimension segment_filter_unsupported unsupported_scope ai_overview_data_unavailable prompt_data_unavailable

message

required

string

Example

{
  "error": {
    "code": "rate_limit_exceeded",
    "message": "Rate limit exceeded. Try again later."
  }
}

500

Internal server error

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: validation_error bad_request project_not_found segment_not_found forbidden crawl_in_progress not_found upstream_error unauthorized rate_limit_exceeded api_access_denied internal_error crawl_not_found invalid_date_range invalid_filter invalid_event_type keyword_not_found opportunity_not_found snapshot_unavailable gsc_not_connected ga4_not_connected site_audit_data_unavailable ga4_data_unavailable unsupported_filter unsupported_dimension segment_filter_unsupported unsupported_scope ai_overview_data_unavailable prompt_data_unavailable

message

required

string

Example

{
  "error": {
    "code": "internal_error",
    "message": "Internal server error."
  }
}

502

Upstream Site Audit service error

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: validation_error bad_request project_not_found segment_not_found forbidden crawl_in_progress not_found upstream_error unauthorized rate_limit_exceeded api_access_denied internal_error crawl_not_found invalid_date_range invalid_filter invalid_event_type keyword_not_found opportunity_not_found snapshot_unavailable gsc_not_connected ga4_not_connected site_audit_data_unavailable ga4_data_unavailable unsupported_filter unsupported_dimension segment_filter_unsupported unsupported_scope ai_overview_data_unavailable prompt_data_unavailable

message

required

string

Example

{
  "error": {
    "code": "upstream_error",
    "message": "The upstream Site Audit service is temporarily unavailable. Try again later."
  }
}