Skip to content
Sitechecker API documentationSitechecker API documentationSitechecker API

Page Details Overview

GET
/api/v1/page_details
curl --request GET \
  --url 'https://sitechecker.pro/api/v1/page_details?project_id=12345&url=https%3A%2F%2Fexample.com%2Fpage&include=url_inspection&internal_links_limit=50&internal_links_offset=0&external_links_limit=50&external_links_offset=0&internal_backlinks_limit=50&internal_backlinks_offset=0&internal_backlink_anchors_limit=50&internal_backlink_anchors_offset=0&images_limit=50&images_offset=0&css_files_limit=50&css_files_offset=0&javascript_files_limit=50&javascript_files_offset=0' \
  --header 'Authorization: Bearer <token>'

Returns structured audit context for a single URL, including default overview and URL inspection data, with one optional page-level block available per request.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
project_id
required
integer
Example
12345

Project ID.

url
required
string
Example
https://example.com/page
include
string
Allowed values: url_inspection keyword_gap localization content structured_data internal_backlinks internal_backlink_anchors internal_links external_links images css_files javascript_files mobile_pagespeed desktop_pagespeed

One optional block to attach to the response (returned under its own key).

internal_links_limit
integer
default: 50 <= 50
internal_links_offset
integer
0
external_links_limit
integer
default: 50 <= 50
external_links_offset
integer
0
internal_backlinks_limit
integer
default: 50 <= 50
internal_backlinks_offset
integer
0
internal_backlink_anchors_limit
integer
default: 50 <= 50
internal_backlink_anchors_offset
integer
0
images_limit
integer
default: 50 <= 50
images_offset
integer
0
css_files_limit
integer
default: 50 <= 50
css_files_offset
integer
0
javascript_files_limit
integer
default: 50 <= 50
javascript_files_offset
integer
0

Responses

Section titled “Responses”

200

Section titled “200”

Page details (overview by default; one include block under its own key)

Media typeapplication/json
object
data

Default response: the overview block. url_inspection and optional include blocks (content, structured_data, localization, internal/external links, pagespeed, images, css/js files) are planned and not yet returned.

object
project_id

Project ID.

integer
url

Requested page URL.

string
current_crawl_date

Latest completed Site Audit crawl used for returned page details.

string format: date-time
nullable
overview
object
url_info
object
url

Page URL from crawl data.

string
nullable
http_status_code

HTTP status code detected during crawl.

integer
nullable
content_type

Page content type.

string
nullable
meta_viewport

Meta viewport values found on the page.

Array<string>
canonical_url

Canonical URL found on the page.

string
nullable
meta_robots

Meta robots directives found on the page.

Array<string>
robots_txt_status

Robots.txt crawl status for this page.

string
nullable
found_at

Sources where this URL was discovered.

Array<string>
http_headers
Array<object>
object
name

HTTP header name.

string
value

HTTP header value.

string
Example
{
  "data": {
    "project_id": 12345,
    "url": "https://example.com/page-1"
  }
}

401

Section titled “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

Section titled “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

Section titled “404”

Project 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

Section titled “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

Section titled “422”

Invalid query parameters (unknown/unavailable include, bad pagination)

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

Section titled “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

Section titled “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

Section titled “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."
  }
}