Site Audit Summary

GET

/api/v1/audit_summary

curl --request GET \
  --url 'https://sitechecker.pro/api/v1/audit_summary?project_id=12345&segment_id=all_pages' \
  --header 'Authorization: Bearer <token>'

• Production

Returns the latest Site Audit summary for a project or segment, including website score, crawl status, crawled pages, issue counts, and changes compared with the previous crawl.

Authorizations

• bearerAuth

Parameters

Query Parameters

project_id

required

integer

Example

12345

Project ID.

segment_id

string

Example

all_pages

Optional segment scope filter.

Responses

200

Audit summary

Media typeapplication/json

object

data

object

website_score

Current Website Score.

integer

nullable

website_score_diff

Diff vs previous crawl.

integer

nullable

crawled_pages_count

Current crawled pages count.

integer

nullable

crawled_pages_count_diff

Diff vs previous crawl.

integer

nullable

indexable_pages_count

Current indexable pages count.

integer

nullable

indexable_pages_count_diff

Diff vs previous crawl.

integer

nullable

current_crawl_date

Latest crawl date.

string format: date-time

nullable

previous_crawl_date

Previous crawl date used for diff.

string format: date-time

nullable

severity_groups

Array<object>

object

severity

Possible severity: critical / warning / opportunity / notice.

string

Allowed values: critical warning opportunity notice

affected_pages_count

Affected pages count for severity group.

integer

affected_pages_count_diff

Diff vs previous crawl.

integer

nullable

category_groups

Array<object>

object

category

Issue category. Possible categories: links / indexability / content_relevance / duplicate_content / security / internal / page_speed / redirects / social_media / localization / code_validation / xml_sitemaps / mobile_friendly.

string

issue_types_count

Count of unique audit issue types grouped under this category.

integer

affected_pages_count

Affected pages count for this category.

integer

affected_pages_count_diff

Diff vs previous crawl.

integer

nullable

Example

{
  "data": {
    "website_score": 78,
    "website_score_diff": -7,
    "crawled_pages_count": 15432,
    "crawled_pages_count_diff": 250,
    "indexable_pages_count": 13210,
    "indexable_pages_count_diff": -42,
    "current_crawl_date": "2026-05-12T08:30:00Z",
    "previous_crawl_date": "2026-05-05T08:30:00Z",
    "severity_groups": [
      {
        "severity": "critical",
        "affected_pages_count": 523,
        "affected_pages_count_diff": -10
      }
    ],
    "category_groups": [
      {
        "category": "links",
        "issue_types_count": 23,
        "affected_pages_count": 2475,
        "affected_pages_count_diff": -34
      }
    ]
  }
}

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."
  }
}