Map multiple URLs based on options

Request body

urlstring uri required

The base URL to start crawling from

searchstring

Specify a search query to order the results by relevance. Example: 'blog' will return URLs that contain the word 'blog' in the URL ordered by relevance.

sitemap'skip' | 'include' | 'only'

Sitemap mode when mapping. If you set it to skip, the sitemap won't be used to find URLs. If you set it to only, only URLs that are in the sitemap will be returned. By default (include), the sitemap and other methods will be used together to find URLs.

includeSubdomainsboolean

Include subdomains of the website

ignoreQueryParametersboolean

Do not return URLs with query parameters

ignoreCacheboolean

Bypass the sitemap cache to retrieve fresh URLs. Sitemap data is cached for up to 7 days; use this parameter when your sitemap has been recently updated.

limitinteger

Maximum number of links to return

timeoutinteger

Timeout in milliseconds. There is no timeout by default.

Example request

{
  "location": {
    "languages": [
      "en-US"
    ]
  },
  "threatProtection": {
    "riskScoreThreshold": 75
  }
}

Response

Successful response

successboolean

v1

Map multiple URLs based on options

Request body

Example request

Response