Preview the URLs a crawl would discover from one page (its links and, optionally, sitemaps). Synchronous, at most 30 s; nothing is stored. Editors and above, or an API key with the ingest scope.

POST/v1/teams/{team}/web/map

Path Parameters

team*string

Team slug or ID

application/json

TypeScript Definitions

Use the request body type in TypeScript.

url*string

useSitemaps?boolean

Defaultfalse

limit?integer

Range1 <= value <= 2000

Default500

includePrefixes?array<string>

exclude?array<string>

allowSubdomains?boolean

Defaultfalse

curl -X POST "https://example.com/v1/teams/string/web/map" \  -H "Content-Type: application/json" \  -d '{    "url": "string"  }'

{  "data": {    "urls": [      "string"    ],    "truncated": true,    "sitemapUrls": 0  }}