{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/serpkite-com/json-schema/serpkite-com-map-request-schema.json",
  "title": "MapRequest",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/serpkite-com-map-api-openapi.yml#/components/schemas/MapRequest",
  "type": "object",
  "required": [
    "url"
  ],
  "properties": {
    "url": {
      "type": "string",
      "format": "uri",
      "description": "The site (any page of it; sitemaps are read from its origin)"
    },
    "search": {
      "type": "string",
      "maxLength": 512,
      "description": "Keep only URLs relevant to these words, most relevant first. When the sitemap lists fewer than 50 URLs, up to 8 of the start page's links are read too, one level deeper"
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 5000,
      "default": 100
    },
    "include_subdomains": {
      "type": "boolean",
      "default": false
    },
    "include_paths": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "maxItems": 20,
      "description": "Regular expressions matched against the URL path; keep only URLs matching one"
    },
    "exclude_paths": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "maxItems": 20,
      "description": "Regular expressions matched against the URL path; drop URLs matching one"
    },
    "ignore_query_parameters": {
      "type": "boolean",
      "default": false,
      "description": "Treat URLs that differ only in their query string as one (the first one found is kept)"
    },
    "sitemap": {
      "type": "string",
      "enum": [
        "include",
        "only",
        "skip"
      ],
      "default": "include",
      "description": "`include` sitemaps and the start page's links, `only` sitemaps, `skip` sitemaps (links only)"
    }
  }
}