Nexscope

Resource Affected Pages

Find which pages on a website are affected by a broken or slow resource. Call the Resource Affected Pages API via REST or MCP to automate SEO research.

CostEstimated 10 credits / call
Try online
POST · https://api.nexscope.ai/seo/resourceAffectedPagesMCP · nexscope_resource_affected_pages

What this API does

Find which pages on a website are affected by a broken or slow resource. The request accepts limit, resourceUrl, task_id. Its documented result includes page.canonical, page.checks.hasMicromarkup, page.checks.hasMicromarkupErrors, page.checks.is4xx, page.checks.is5xx, page.checks.isBroken, page.checks.isHttps, page.checks.noDescription.

Resource Affected Pages API use cases

Investigate a website quality issue

To investigate a website quality issue, a marketplace analyst submits limit and resourceUrl to Resource Affected Pages. The returned page.canonical, page.checks.hasMicromarkup, page.checks.hasMicromarkupErrors help locate the pages or resources behind the reported issue.

Prioritize pages for technical review

A marketplace analyst uses Resource Affected Pages with limit and resourceUrl to prioritize pages for technical review. The returned page.canonical, page.checks.hasMicromarkup, page.checks.hasMicromarkupErrors help choose affected pages for the next technical investigation.

Record evidence before a site change

For this workflow, a marketplace analyst calls Resource Affected Pages with limit and resourceUrl to record evidence before a site change. The result helps compare saved evidence before and after a site correction.

Resource Affected Pages API FAQ

What does the Resource Affected Pages API return?

Find which pages on a website are affected by a broken or slow resource. The documented output includes page.canonical, page.checks.hasMicromarkup, page.checks.hasMicromarkupErrors, page.checks.is4xx, page.checks.is5xx, page.checks.isBroken, page.checks.isHttps, page.checks.noDescription. It corresponds to the supplied limit, resourceUrl, task_id. 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 Resource Affected Pages API cost?

The current documented cost is Estimated 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 Resource Affected Pages API from my app or an MCP client?

Send a POST request to https://api.nexscope.ai/seo/resourceAffectedPages 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_resource_affected_pages. 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 creditsConnect this API with MCP

Try this API
Endpoint
https://api.nexscope.ai/seo/resourceAffectedPages
MCP method
nexscope_resource_affected_pages

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/resourceAffectedPages

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/resourceAffectedPages' \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "limit": 10,
  "resourceUrl": "https://www.nexscope.ai/",
  "task_id": ""
}'

Code example

{
  "limit": 10,
  "resourceUrl": "https://www.nexscope.ai/",
  "task_id": ""
}

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

CodeDescription
200Default HTTP response for both success and many business errors. Only outer JSON code 0 indicates success or asynchronous acceptance; inspect data for the result.
429Execution admission rate limit; honor Retry-After when present.
503Execution admission is temporarily unavailable; honor Retry-After when present.
Opt-inX-Nexscope-Http-Status: semantic maps controller-handled business errors to HTTP status on run and task routes. Pre-authentication failures, such as a missing or invalid API key (code 11209, including an incomplete or corrupted copy) or an expired website login session (code 12001), may still return HTTP 200 before this mapping. Always check the outer JSON code; malformed requests and infrastructure failures may also return non-200 HTTP responses.
All categories/ Website & On-Page SEO
POSThttps://api.nexscope.ai/seo/resourceAffectedPages

Run this API

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

Endpoint

MethodPOST
Pathhttps://api.nexscope.ai/seo/resourceAffectedPages
AuthBearer API key
Content-Typeapplication/json

Request parameters

NameTypeRequiredDescription
limitintegeroptional
Limit value used by this API operation.
Default: 10
Minimum: 1
Maximum: 10
resourceUrlstringrequired
Resource url value used by this API operation.
Format: uri
Maximum length: 2048
task_idstringrequired
Task id value used by this API operation.
Minimum length: 1
Maximum length: 64

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": [
        {
          "page": {
            "canonical": "synthetic",
            "checks": {
              "hasMicromarkup": false,
              "hasMicromarkupErrors": false,
              "is4xx": false,
              "is5xx": false,
              "isBroken": false,
              "isHttps": false,
              "noDescription": false,
              "noH1": false
            },
            "description": "synthetic",
            "onpageScore": 1.25,
            "sizeBytes": 9007199254740992,
            "statusCode": 9007199254740992,
            "title": "synthetic",
            "url": "synthetic"
          },
          "resourceUrl": "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

NameTypeRequiredDescription
codeintegerrequired
0 is a successful envelope; inspect data.status separately.
Allowed: 0, 42008, 42009
coststringrequired
Elapsed processing milliseconds; not price. -1 for non-web context.
dataobjectrequired
Data value used by this API operation.
data.callIdstring | nulloptional
Call id value used by this API operation.
data.completedAtstring | integer | nulloptional
Completed at value used by this API operation.
data.coverageobjectoptional
Coverage value used by this API operation.
data.coverage.missingarrayoptional
Missing value used by this API operation.
data.coverage.missing[]objectrequired
Item in data coverage missing.
data.coverage.missing[].fieldstringoptional
Field value used by this API operation.
data.coverage.missing[].reasonstringoptional
Reason value used by this API operation.
data.coverage.statusstringoptional
Status value used by this API operation.
data.requestedAtstring | integer | nulloptional
Requested at value used by this API operation.
data.resultobject | nullrequired
Result value used by this API operation.
data.result.coverageobjectrequired
Coverage value used by this API operation.
data.result.coverage.invalidItemCountintegerrequired
Invalid item count value used by this API operation.
Minimum: 0
data.result.coverage.limitintegerrequired
Limit value used by this API operation.
Minimum: 0
data.result.coverage.maxCrawlPagesinteger | nullrequired
Max crawl pages value used by this API operation.
Minimum: 0
data.result.coverage.offsetintegerrequired
Offset value used by this API operation.
Minimum: 0
data.result.coverage.pagesCrawledinteger | nullrequired
Pages crawled value used by this API operation.
Minimum: 0
data.result.coverage.providerTotalinteger | nullrequired
Provider total value used by this API operation.
Minimum: 0
data.result.coverage.returnedCountintegerrequired
Returned count value used by this API operation.
Minimum: 0
data.result.coverage.sampledbooleanrequired
Sampled value used by this API operation.
Constant: true
data.result.coverage.stopReasonstring | nullrequired
Stop reason value used by this API operation.
data.result.coverage.truncatedbooleanrequired
Truncated value used by this API operation.
data.result.itemsarrayrequired
Items value used by this API operation.
Maximum items: 10
data.result.items[]objectrequired
Item in data result items.
data.result.items[].pageobjectrequired
Page value used by this API operation.
data.result.items[].page.canonicalstring | nullrequired
Canonical value used by this API operation.
Maximum length: 2048
data.result.items[].page.checksobjectrequired
Checks value used by this API operation.
data.result.items[].page.checks.hasMicromarkupboolean | nullrequired
Has micromarkup value used by this API operation.
data.result.items[].page.checks.hasMicromarkupErrorsboolean | nullrequired
Has micromarkup errors value used by this API operation.
data.result.items[].page.checks.is4xxboolean | nullrequired
Is4xx value used by this API operation.
data.result.items[].page.checks.is5xxboolean | nullrequired
Is5xx value used by this API operation.
data.result.items[].page.checks.isBrokenboolean | nullrequired
Is broken value used by this API operation.
data.result.items[].page.checks.isHttpsboolean | nullrequired
Is https value used by this API operation.
data.result.items[].page.checks.noDescriptionboolean | nullrequired
No description value used by this API operation.
data.result.items[].page.checks.noH1boolean | nullrequired
No h1 value used by this API operation.
data.result.items[].page.descriptionstring | nullrequired
Description value used by this API operation.
Maximum length: 4096
data.result.items[].page.onpageScorenumber | nullrequired
Onpage score value used by this API operation.
Minimum: 0
Maximum: 100
data.result.items[].page.sizeBytesinteger | nullrequired
Size bytes value used by this API operation.
Minimum: 0
Maximum: 9007199254740991
data.result.items[].page.statusCodeinteger | nullrequired
Status code value used by this API operation.
Minimum: 100
Maximum: 599
data.result.items[].page.titlestring | nullrequired
Title value used by this API operation.
Maximum length: 4096
data.result.items[].page.urlstringrequired
Url value used by this API operation.
Maximum length: 2048
data.result.items[].resourceUrlstringrequired
Resource url value used by this API operation.
Maximum length: 2048
data.result.missingFieldsarrayrequired
Missing fields value used by this API operation.
Maximum items: 10000
data.result.missingFields[]objectrequired
Item in data result missingFields.
data.result.missingFields[].fieldstringrequired
Field value used by this API operation.
data.result.missingFields[].reasonstringrequired
Reason value used by this API operation.
data.result.sourceobjectrequired
Source value used by this API operation.
data.result.source.candidateIdstringrequired
Candidate id value used by this API operation.
Constant: MD-PW-04
data.result.source.collectedAtinteger | nullrequired
Collected at value used by this API operation.
Minimum: 0
Maximum: 9007199254740991
data.result.source.observationKindstringrequired
Observation kind value used by this API operation.
Constant: CRAWL_SAMPLE
data.result.source.productstringrequired
Product value used by this API operation.
Constant: on_page
data.result.source.providerstringrequired
Provider value used by this API operation.
Constant: DATAFORSEO
data.result.source.queriedAtintegerrequired
Queried at value used by this API operation.
Minimum: 0
Maximum: 9007199254740991
data.result.source.sourceCallIdstring | nullrequired
Source call id value used by this API operation.
data.result.source.sourcePlanVersionstring | nullrequired
Source plan version value used by this API operation.
data.result.source.sourceSchemaVersionstring | nullrequired
Source schema version value used by this API operation.
data.result.warningsarrayrequired
Warnings value used by this API operation.
Maximum items: 1000
data.result.warnings[]stringrequired
Item in data result warnings.
data.schemaVersionstring | nulloptional
Schema version value used by this API operation.
data.sourcestring | nulloptional
Source value used by this API operation.
data.statusstringoptional
Status value used by this API operation.
Allowed: SUCCESS, PARTIAL, EMPTY, PROCESSING, UNKNOWN, FAILED
data.usageobject | nulloptional
Usage value used by this API operation.
data.usage.billingStatusstring | nulloptional
Billing status value used by this API operation.
data.usage.chargedCreditsstring | integer | nulloptional
Charged credits value used by this API operation.
msgstring | nullrequired
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.
timestringrequired
yyyy-MM-dd HH:mm:ss
traceIdstring | nullrequired
Trace id value used by this API operation.
tsstringrequired
Epoch milliseconds; global long serializer.

Accepted processing response

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

NameTypeRequiredDescription
codeintegerrequired
0 is a successful envelope; inspect data.status separately.
Constant: 0
coststringrequired
Elapsed processing milliseconds; not price. -1 for non-web context.
dataobjectrequired
Data value used by this API operation.
data.callIdstring | nullrequired
Call id value used by this API operation.
data.reasonstringrequired
Reason value used by this API operation.
Constant: IN_PROGRESS
data.retryablebooleanoptional
Retryable value used by this API operation.
data.statusstringrequired
Status value used by this API operation.
Constant: PROCESSING
data.taskIdstring | nulloptional
Task id value used by this API operation.
msgstring | nullrequired
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.
timestringrequired
yyyy-MM-dd HH:mm:ss
traceIdstring | nullrequired
Trace id value used by this API operation.
tsstringrequired
Epoch milliseconds; global long serializer.

Error response

NameTypeRequiredDescription
codeintegerrequired
0 is a successful envelope; inspect data.status separately.
coststringrequired
Elapsed processing milliseconds; not price. -1 for non-web context.
dataobjectrequired
Data value used by this API operation.
data.callIdstring | nullrequired
Call id value used by this API operation.
data.reasonstring | nullrequired
Reason value used by this API operation.
data.retryablebooleanoptional
Retryable value used by this API operation.
data.statusstring | nullrequired
Status value used by this API operation.
data.taskIdstring | nulloptional
Task id value used by this API operation.
msgstring | nullrequired
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.
timestringrequired
yyyy-MM-dd HH:mm:ss
traceIdstring | nullrequired
Trace id value used by this API operation.
tsstringrequired
Epoch milliseconds; global long serializer.

Retrieve a processing result

A response withPROCESSING and a callIdmeans 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/resourceAffectedPages/calls/{callId} \
  -H "Authorization: Bearer nk-xxxxxxxxxxxxxxxxx"

Responses

CodeDescription
200Default HTTP response for both success and many business errors. Only outer JSON code 0 indicates success or asynchronous acceptance; inspect data for the result.
429Execution admission rate limit; honor Retry-After when present.
503Execution admission is temporarily unavailable; honor Retry-After when present.
Opt-inX-Nexscope-Http-Status: semantic maps controller-handled business errors to HTTP status on run and task routes. Pre-authentication failures, such as a missing or invalid API key (code 11209, including an incomplete or corrupted copy) or an expired website login session (code 12001), may still return HTTP 200 before this mapping. Always check the outer JSON code; malformed requests and infrastructure failures may also return non-200 HTTP responses.

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_resource_affected_pages",
    "arguments": {
      "limit": 10,
      "resourceUrl": "https://www.nexscope.ai/",
      "task_id": ""
    }
  }
}

Legacy MCP v1

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

GET / POST /mcp/legacy

What can you do with this API?

Data explained and practical use cases

AI Guide

Question

What page data can Resource Affected Pages provide for a resource URL, and how might I use it?

AI answer

Resource Affected Pages returns a sampled set of crawled pages associated with a specified resource URL, together with page checks and coverage details. The example response is still PROCESSING; the fields below describe the documented completed result, not data present in that example.

Data categoryDocumented field namesWhat the values mean
Affected page and resourcedata.result.items[].page.url, data.result.items[].page.canonical, data.result.items[].resourceUrlThe page URL, its canonical URL when available, and the resource URL linked to the item.
Page response and conditiondata.result.items[].page.statusCode, data.result.items[].page.checks.isBroken, data.result.items[].page.checks.is4xx, data.result.items[].page.checks.is5xxThe page's HTTP status and documented page checks. These fields do not quantify the resource's speed.
Page content and qualitydata.result.items[].page.title, data.result.items[].page.description, data.result.items[].page.onpageScore, data.result.items[].page.checks.noH1, data.result.items[].page.checks.noDescriptionPage labels, an on-page score, and checks for missing headings or descriptions.
Structured data and HTTPSdata.result.items[].page.checks.hasMicromarkup, data.result.items[].page.checks.hasMicromarkupErrors, data.result.items[].page.checks.isHttpsChecks for structured markup, markup errors, and HTTPS. A null check value is not a negative finding.
Sample coveragedata.result.coverage.returnedCount, data.result.coverage.providerTotal, data.result.coverage.sampled, data.result.coverage.truncated, data.result.coverage.stopReasonHow much of the provider's page set was returned and whether the sample was cut short. Results contain at most 10 items.
Missing datadata.result.missingFields[].field, data.result.missingFields[].reason, data.result.warnings[]Fields that could not be supplied, their reasons, and other result warnings.
  • Find which returned pages reference a resource you are investigating and prioritize those pages for review.
    • Prompt example: “I am researching products for an online store. Could you find which returned pages reference a resource you are investigating and prioritize those pages for review? Show the returned values behind the comparison, and mark missing data.”
  • Spot returned pages that also have 4xx, 5xx, or broken-page flags.
    • Prompt example: “I am researching products for an online store. Could you spot returned pages that also have 4xx, 5xx, or broken-page flags? Show the relevant returned evidence and tell me what input you need from me.”
  • Use titles and canonical URLs to identify duplicate or important pages in the sample.
    • Prompt example: “I am researching products for an online store. Could you use titles and canonical URLs to identify duplicate or important pages in the sample? Show matching records and source links where the API provides them; ask me for any required identifier or filter.”
  • Check truncated, returnedCount, and missingFields before treating the returned list as representative of the crawl.
    • Prompt example: “I am researching products for an online store. Could you check truncated, returnedCount, and missingFields before treating the returned list as representative of the crawl? Show the relevant returned evidence and tell me what input you need from me.”

Related APIs