Website Audit Summary

Get an SEO audit summary of a website, with issues found during a crawl. Call the Website Audit Summary API via REST or MCP to automate SEO research.

CostRecent 10 credits / call

Try online

POST · https://api.nexscope.ai/seo/websiteAuditSummaryMCP · nexscope_website_audit_summary

Choose an integration method

Website & On-Page SEO

What this API does

Get an SEO audit summary of a website, with issues found during a crawl. The request accepts profile, target. Its documented result includes brokenLinks, brokenResources, crawlEndedAt, crawlStartedAt, duplicateContents, duplicateDescriptions, duplicateTitles, externalLinks.

Website Audit Summary API use cases

Investigate a website quality issue

To investigate a website quality issue, a search marketer submits profile and target to Website Audit Summary. The returned brokenLinks, brokenResources, crawlEndedAt help locate the pages or resources behind the reported issue.

Prioritize pages for technical review

A search marketer uses Website Audit Summary with profile and target to prioritize pages for technical review. The returned brokenLinks, brokenResources, crawlEndedAt help choose affected pages for the next technical investigation.

Record evidence before a site change

For this workflow, a search marketer calls Website Audit Summary with profile and target to record evidence before a site change. The result helps compare saved evidence before and after a site correction.

Website Audit Summary API FAQ

What does the Website Audit Summary API return?

Get an SEO audit summary of a website, with issues found during a crawl. The documented output includes brokenLinks, brokenResources, crawlEndedAt, crawlStartedAt, duplicateContents, duplicateDescriptions, duplicateTitles, externalLinks. It corresponds to the supplied profile, target. Optional fields can be absent; a missing value should not be interpreted as a measured zero. Example values illustrate the response shape, rather than live account results.

How many credits does the Website Audit Summary API cost?

The current documented cost is Recent 10 credits / call. This is the same cost shown at the top of this page. If a range or estimate is displayed, the final charge depends on the request. Review your available credits and the pricing page before calling the API, and check API usage records for the actual charge.

How do I call the Website Audit Summary API from my app or an MCP client?

Send a POST request to https://api.nexscope.ai/seo/websiteAuditSummary with your API key as a Bearer token and the JSON inputs shown in API integration. In a compatible MCP client such as Claude or Cursor, connect Nexscope and call nexscope_website_audit_summary. Use the MCP arguments shown in the MCP guide, or switch Online test to MCP to review its request before adding it to your app.

View plans and credits Connect this API with MCP

Try this API

Endpoint

https://api.nexscope.ai/seo/websiteAuditSummary

MCP method

nexscope_website_audit_summary

Step 1 of 3 · Authenticate

Authentication

All run endpoints require a user API key. Send it as a bearer token in the Authorization header.

Authorization: Bearer nk-xxxxxxxxxxxxxxxxx

Missing or invalid API keys return an authentication error. Manage keys from .

Step 2 of 3 · Send a request

POSThttps://api.nexscope.ai/seo/websiteAuditSummary

Run an API

Send a JSON request body using the parameters described below.

Example request

Replace YOUR_API_KEY, then run this command in your terminal.

curl -X POST 'https://api.nexscope.ai/seo/websiteAuditSummary' \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "profile": "BASE",
  "target": "nexscope.ai"
}'

Step 3 of 3 · Inspect the result

Check the response

Read code for the request status and data for the result. Open the parameter and response reference for the full field definitions.

HTTP status codes

Code	Description
200	HTTP request completed. Check JSON code; only 0 indicates business success or acceptance.
400	Request JSON or required API parameters are invalid.
401	API key is missing, invalid, or cannot be matched to a user.
5xx	API execution or upstream service failed.

View parameters & response Try online

All categories/ Website & On-Page SEO

POSThttps://api.nexscope.ai/seo/websiteAuditSummary

Run this API

Send a JSON request to execute this API and receive the documented response payload.

Open tester

Endpoint

Method	`POST`
Path	`https://api.nexscope.ai/seo/websiteAuditSummary`
Auth	`Bearer API key`
Content-Type	`application/json`

Request parameters

Name	Type	Required	Description
`profile`	`string`	optional	Profile value used by this API operation. Allowed: BASE, ENRICHED Default: BASE
`target`	`string`	required	Target value used by this API operation. Maximum length: 253

Code example

{
  "profile": "BASE",
  "target": "nexscope.ai"
}

Response example

Example response envelope from the documented SEO API contract.

{
  "code": 0,
  "cost": "-1",
  "data": {
    "callId": "synthetic-call",
    "completedAt": null,
    "coverage": {
      "missing": [
        {
          "field": "synthetic",
          "reason": "UPSTREAM_FIELD_MISSING"
        }
      ],
      "status": "PARTIAL"
    },
    "requestedAt": "123",
    "result": {
      "coverage": {
        "invalidItemCount": 1,
        "limit": 1,
        "maxCrawlPages": 9007199254740992,
        "offset": 1,
        "pagesCrawled": 9007199254740992,
        "providerTotal": 9007199254740992,
        "returnedCount": 1,
        "sampled": false,
        "stopReason": "synthetic",
        "truncated": false
      },
      "items": [
        {
          "brokenLinks": 9007199254740992,
          "brokenResources": 9007199254740992,
          "crawlEndedAt": 9007199254740992,
          "crawlStartedAt": 9007199254740992,
          "duplicateContents": 9007199254740992,
          "duplicateDescriptions": 9007199254740992,
          "duplicateTitles": 9007199254740992,
          "externalLinks": 9007199254740992,
          "internalLinks": 9007199254740992,
          "nonIndexable": 9007199254740992,
          "onpageScore": 1.25,
          "pagesCrawled": 9007199254740992,
          "profile": "synthetic",
          "stopReason": "synthetic",
          "target": "synthetic"
        }
      ],
      "missingFields": [
        {
          "field": "synthetic",
          "reason": "synthetic"
        }
      ],
      "source": {
        "candidateId": "synthetic",
        "collectedAt": 9007199254740992,
        "observationKind": "synthetic",
        "product": "synthetic",
        "provider": "synthetic",
        "queriedAt": 9007199254740992,
        "sourceCallId": "synthetic",
        "sourcePlanVersion": "synthetic",
        "sourceSchemaVersion": "synthetic"
      },
      "warnings": [
        "synthetic"
      ]
    },
    "schemaVersion": "synthetic",
    "source": "synthetic",
    "status": "PARTIAL",
    "usage": {
      "billingStatus": "UNAPPROVED",
      "chargedCredits": "0"
    }
  },
  "msg": null,
  "time": "2026-01-01 00:00:00",
  "traceId": "synthetic-trace",
  "ts": "9007199254740993"
}

Response fields

Name	Type	Required	Description
`code`	`integer`	required	0 is a successful envelope; inspect data.status separately. Allowed: 0, 42008, 42009
`cost`	`string`	required	Elapsed processing milliseconds; not price. -1 for non-web context.
`data`	`object`	required	Data value used by this API operation.
`data.callId`	`string \| null`	optional	Call id value used by this API operation.
`data.completedAt`	`string \| integer \| null`	optional	Completed at value used by this API operation.
`data.coverage`	`object`	optional	Coverage value used by this API operation.
`data.coverage.missing`	`array`	optional	Missing value used by this API operation.
`data.coverage.missing[]`	`object`	required	Item in data coverage missing.
`data.coverage.missing[].field`	`string`	optional	Field value used by this API operation.
`data.coverage.missing[].reason`	`string`	optional	Reason value used by this API operation.
`data.coverage.status`	`string`	optional	Status value used by this API operation.
`data.requestedAt`	`string \| integer \| null`	optional	Requested at value used by this API operation.
`data.result`	`object \| null`	required	Result value used by this API operation.
`data.result.coverage`	`object`	required	Coverage value used by this API operation.
`data.result.coverage.invalidItemCount`	`integer`	required	Invalid item count value used by this API operation. Minimum: 0 Maximum: 9007199254740991
`data.result.coverage.limit`	`integer`	required	Limit value used by this API operation. Minimum: 0 Maximum: 9007199254740991
`data.result.coverage.maxCrawlPages`	`integer \| null`	required	Max crawl pages value used by this API operation. Minimum: 0 Maximum: 9007199254740991
`data.result.coverage.offset`	`integer`	required	Offset value used by this API operation. Minimum: 0 Maximum: 9007199254740991
`data.result.coverage.pagesCrawled`	`integer \| null`	required	Pages crawled value used by this API operation. Minimum: 0 Maximum: 9007199254740991
`data.result.coverage.providerTotal`	`integer \| null`	required	Provider total value used by this API operation. Minimum: 0 Maximum: 9007199254740991
`data.result.coverage.returnedCount`	`integer`	required	Returned count value used by this API operation. Minimum: 0 Maximum: 9007199254740991
`data.result.coverage.sampled`	`boolean`	required	Sampled value used by this API operation. Constant: true
`data.result.coverage.stopReason`	`string \| null`	required	Stop reason value used by this API operation.
`data.result.coverage.truncated`	`boolean`	required	Truncated value used by this API operation.
`data.result.items`	`array`	required	Items value used by this API operation. Maximum items: 1
`data.result.items[]`	`object`	required	Item in data result items.
`data.result.items[].brokenLinks`	`integer \| null`	required	Broken links value used by this API operation. Minimum: 0 Maximum: 9007199254740991
`data.result.items[].brokenResources`	`integer \| null`	required	Broken resources value used by this API operation. Minimum: 0 Maximum: 9007199254740991
`data.result.items[].crawlEndedAt`	`integer \| null`	required	Crawl ended at value used by this API operation. Minimum: 0 Maximum: 9007199254740991
`data.result.items[].crawlStartedAt`	`integer \| null`	required	Crawl started at value used by this API operation. Minimum: 0 Maximum: 9007199254740991
`data.result.items[].duplicateContents`	`integer \| null`	required	Duplicate contents value used by this API operation. Minimum: 0 Maximum: 9007199254740991
`data.result.items[].duplicateDescriptions`	`integer \| null`	required	Duplicate descriptions value used by this API operation. Minimum: 0 Maximum: 9007199254740991
`data.result.items[].duplicateTitles`	`integer \| null`	required	Duplicate titles value used by this API operation. Minimum: 0 Maximum: 9007199254740991
`data.result.items[].externalLinks`	`integer \| null`	required	External links value used by this API operation. Minimum: 0 Maximum: 9007199254740991
`data.result.items[].internalLinks`	`integer \| null`	required	Internal links value used by this API operation. Minimum: 0 Maximum: 9007199254740991
`data.result.items[].nonIndexable`	`integer \| null`	required	Non indexable value used by this API operation. Minimum: 0 Maximum: 9007199254740991
`data.result.items[].onpageScore`	`number \| null`	required	Onpage score value used by this API operation. Minimum: 0 Maximum: 100
`data.result.items[].pagesCrawled`	`integer \| null`	required	Pages crawled value used by this API operation. Minimum: 0 Maximum: 9007199254740991
`data.result.items[].profile`	`string`	required	Profile value used by this API operation. Allowed: BASE, ENRICHED
`data.result.items[].stopReason`	`string \| null`	required	Stop reason value used by this API operation.
`data.result.items[].target`	`string`	required	Target value used by this API operation.
`data.result.missingFields`	`array`	required	Missing fields value used by this API operation. Maximum items: 10000
`data.result.missingFields[]`	`object`	required	Item in data result missingFields.
`data.result.missingFields[].field`	`string`	required	Field value used by this API operation.
`data.result.missingFields[].reason`	`string`	required	Reason value used by this API operation.
`data.result.source`	`object`	required	Source value used by this API operation.
`data.result.source.candidateId`	`string`	required	Candidate id value used by this API operation. Constant: MD-PW-02
`data.result.source.collectedAt`	`integer \| null`	required	Collected at value used by this API operation. Minimum: 0 Maximum: 9007199254740991
`data.result.source.observationKind`	`string`	required	Observation kind value used by this API operation. Constant: CRAWL_SAMPLE
`data.result.source.product`	`string`	required	Product value used by this API operation. Constant: on_page
`data.result.source.provider`	`string`	required	Provider value used by this API operation. Constant: DATAFORSEO
`data.result.source.queriedAt`	`integer`	required	Queried at value used by this API operation. Minimum: 0 Maximum: 9007199254740991
`data.result.source.sourceCallId`	`string \| null`	required	Source call id value used by this API operation.
`data.result.source.sourcePlanVersion`	`string \| null`	required	Source plan version value used by this API operation.
`data.result.source.sourceSchemaVersion`	`string \| null`	required	Source schema version value used by this API operation.
`data.result.warnings`	`array`	required	Warnings value used by this API operation. Maximum items: 1000
`data.result.warnings[]`	`string`	required	Item in data result warnings.
`data.schemaVersion`	`string \| null`	optional	Schema version value used by this API operation.
`data.source`	`string \| null`	optional	Source value used by this API operation.
`data.status`	`string`	optional	Status value used by this API operation. Allowed: SUCCESS, PARTIAL, EMPTY, PROCESSING, UNKNOWN, FAILED
`data.usage`	`object \| null`	optional	Usage value used by this API operation.
`data.usage.billingStatus`	`string \| null`	optional	Billing status value used by this API operation.
`data.usage.chargedCredits`	`string \| integer \| null`	optional	Charged credits value used by this API operation.
`msg`	`string \| null`	required	Available upstream msg/errmsg/message is preferred for success and failure; Chinese is translated to English. Missing successful message is null. Platform-only errors and task states use platform English. Message text never determines success or retry.
`time`	`string`	required	yyyy-MM-dd HH:mm:ss
`traceId`	`string \| null`	required	Trace id value used by this API operation.
`ts`	`string`	required	Epoch milliseconds; global long serializer.

Accepted processing response

code 0 confirms acceptance. Use data.callId to query the same request; processing is not completion.

Name	Type	Required	Description
`code`	`integer`	required	0 is a successful envelope; inspect data.status separately. Constant: 0
`cost`	`string`	required	Elapsed processing milliseconds; not price. -1 for non-web context.
`data`	`object`	required	Data value used by this API operation.
`data.callId`	`string \| null`	required	Call id value used by this API operation.
`data.reason`	`string`	required	Reason value used by this API operation. Constant: IN_PROGRESS
`data.retryable`	`boolean`	optional	Retryable value used by this API operation.
`data.status`	`string`	required	Status value used by this API operation. Constant: PROCESSING
`data.taskId`	`string \| null`	optional	Task id value used by this API operation.
`msg`	`string \| null`	required	Available upstream msg/errmsg/message is preferred for success and failure; Chinese is translated to English. Missing successful message is null. Platform-only errors and task states use platform English. Message text never determines success or retry.
`time`	`string`	required	yyyy-MM-dd HH:mm:ss
`traceId`	`string \| null`	required	Trace id value used by this API operation.
`ts`	`string`	required	Epoch milliseconds; global long serializer.

Error response

Name	Type	Required	Description
`code`	`integer`	required	0 is a successful envelope; inspect data.status separately.
`cost`	`string`	required	Elapsed processing milliseconds; not price. -1 for non-web context.
`data`	`object`	required	Data value used by this API operation.
`data.callId`	`string \| null`	required	Call id value used by this API operation.
`data.reason`	`string \| null`	required	Reason value used by this API operation.
`data.retryable`	`boolean`	optional	Retryable value used by this API operation.
`data.status`	`string \| null`	required	Status value used by this API operation.
`data.taskId`	`string \| null`	optional	Task id value used by this API operation.
`msg`	`string \| null`	required	Available upstream msg/errmsg/message is preferred for success and failure; Chinese is translated to English. Missing successful message is null. Platform-only errors and task states use platform English. Message text never determines success or retry.
`time`	`string`	required	yyyy-MM-dd HH:mm:ss
`traceId`	`string \| null`	required	Trace id value used by this API operation.
`ts`	`string`	required	Epoch milliseconds; global long serializer.

Retrieve a processing result

A response with PROCESSING and a callId means the result is still being prepared. Use the result query below with the returned identifier. This lookup reads the stored result and does not spend credits.

curl -X GET https://api.nexscope.ai/seo/websiteAuditSummary/calls/{callId} \
  -H "Authorization: Bearer nk-xxxxxxxxxxxxxxxxx"

Responses

Code	Description
200	HTTP request completed. Check JSON code; only 0 indicates business success or acceptance.
400	Request JSON or required API parameters are invalid.
401	API key is missing, invalid, or cannot be matched to a user.
5xx	API execution or upstream service failed.

Data source, freshness, and limitations

Source, freshness, coverage, rate limits, and estimation notes are not specified in this API definition unless they appear in the request or response field documentation above. Do not assume official marketplace data or real-time freshness when it is not explicitly documented.

Step 1 of 2 · Connect your MCP client

MCP

V2 recommended

Connect remote agents through the standard MCP 2025-11-25 Streamable HTTP endpoint. Use OAuth 2.1 Authorization Code with PKCE, or an API key for compatibility.

POST https://api.nexscope.ai/mcp
MCP-Protocol-Version: 2025-11-25
Content-Type: application/json

Authentication

OAuth clients request the mcp:tools scope. The endpoint's 401 response advertises protected-resource metadata for authorization discovery.

Step 2 of 2 · Call the tool

Call a tool

{
  "jsonrpc": "2.0",
  "id": "tool-call-1",
  "method": "tools/call",
  "params": {
    "name": "nexscope_website_audit_summary",
    "arguments": {
      "profile": "BASE",
      "target": "nexscope.ai"
    }
  }
}

Legacy MCP v1

Existing API-key clients can continue using the compatibility endpoint. New integrations should use MCP v2.

GET / POST /mcp/legacy

Online test

Execute the current API with your API key and JSON payload. Online tests use this site's configured API environment; the Endpoint and copyable examples use the public integration address.

Uses your signed-in Nexscope session

SEO API Lab

Website Audit Summary

Get an SEO audit summary of a website, with issues found during a crawl. Call the Website Audit Summary API via REST or MCP to automate SEO research.

Live request

Estimated 10 credits / callAPI usage records

Profile

Choose one of the supported values: BASE, ENRICHED.

2 options

Target

Value sent as the “target” request parameter.

Up to 253 characters

Live calls may use Data credits.

Processing result

If a request is still processing, use the returned identifier to retrieve its stored result. The tester recognizes the identifier automatically, and result queries do not spend credits.

Live response

Results

Your live result will appear here.

Complete the request fields above and run the API. No sample response is substituted.

Test with an API key or MCP

Estimated 10 credits / callAPI usage records

Try it

Send a real request with the same contract shown in the reference.

Endpoint

/seo/websiteAuditSummary

Processing result endpoint

https://api.nexscope.ai/seo/websiteAuditSummary/calls/{resultId}

MCP method

nexscope_website_audit_summary

API key*

JSON payload*

cURL

curl -X POST \
  https://api.nexscope.ai/seo/websiteAuditSummary \
  -H "Authorization: Bearer nk-..." \
  -H "Content-Type: application/json" \
  -d '{ "profile": "BASE", "target": "nexscope.ai" }'

Response

No response yet. Run the request to see the response here.

Processing result

Use the identifier returned by Run request. The tester selects the correct result query automatically, and result queries do not spend credits.

Result identifier

Result response

No task result yet. Query the task to see the generated output here.

Related APIs

Page SEO Evidence

Collect on-page SEO data for a URL, incl. tags, headings and content.

Page Structured Data

Extract the structured data (schema markup) found on a page.

Page Screenshot

Capture a full-page screenshot of any URL for audits and visual checks.

Website Page Checks

Run on-page SEO checks on the pages of a website.