Sitemap URL Discovery (by Domain)

{
  "type": "object",
  "required": [
    "domain"
  ],
  "properties": {
    "zdr": {
      "enum": [
        "enabled",
        "disabled"
      ],
      "type": "string",
      "description": "Set 'enabled' to bypass Context.dev's shared caches and omit request and response content from its retained usage logs. Requires zero data retention on the Context.dev organization, otherwise the call fails with ZDR_NOT_ENABLED."
    },
    "domain": {
      "type": "string",
      "minLength": 3,
      "description": "Domain to build a sitemap for, e.g. 'example.com'."
    },
    "maxLinks": {
      "type": "integer",
      "default": 10000,
      "maximum": 100000,
      "minimum": 1,
      "description": "Maximum number of links to return. Default 10000, max 100000."
    },
    "urlRegex": {
      "type": "string",
      "maxLength": 256,
      "description": "RE2-compatible pattern. Only matching URLs are returned and counted against maxLinks."
    },
    "timeoutMS": {
      "type": "integer",
      "maximum": 300000,
      "minimum": 1000,
      "description": "Upstream timeout in milliseconds (max 300000). Context.dev aborts the call with a 408 when exceeded. Keep it below the endpoint's requestTimeoutMs so the provider answers before the platform's own budget expires."
    },
    "sitemapUrl": {
      "type": "string",
      "format": "uri",
      "description": "Explicit sitemap URL. When provided, exactly this sitemap is crawled instead of discovering the domain's sitemaps."
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "required": [
    "domain",
    "success",
    "urls",
    "meta"
  ],
  "properties": {
    "meta": {
      "type": "object",
      "required": [
        "sitemapsDiscovered",
        "sitemapsFetched",
        "sitemapsSkipped",
        "errors"
      ],
      "properties": {
        "errors": {
          "type": "integer",
          "description": "Count of sitemap-level fetch/parse errors. 0 on both fixtures observed; a non-zero value's effect on `success` is unconfirmed."
        },
        "sitemapsFetched": {
          "type": "integer",
          "description": "How many of the discovered sitemaps were actually downloaded and parsed."
        },
        "sitemapsSkipped": {
          "type": "integer",
          "description": "How many discovered sitemaps were not fetched. Observed non-zero (2 of 2) on a real domain whose sitemaps were located but not retrieved within the call -- a caller cannot assume every discovered sitemap gets fetched."
        },
        "sitemapsDiscovered": {
          "type": "integer",
          "description": "How many sitemap files were located for the domain."
        }
      },
      "additionalProperties": true
    },
    "urls": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The URLs found in the domain's sitemap. Observed populated (10 entries, capped by maxLinks) when a sitemap was discovered and fetched, and observed empty when sitemaps were discovered but none were fetched (see meta.sitemapsFetched) -- an empty array does not necessarily mean the domain has no sitemap."
    },
    "domain": {
      "type": "string",
      "description": "The domain the request targeted, echoed back."
    },
    "success": {
      "type": "boolean",
      "description": "Whether the run completed without a fatal error. Observed true on both fixtures, including the zero-discovered-URLs case -- a caller cannot infer from `success` alone whether any sitemap content was actually retrieved (see meta.sitemapsSkipped)."
    }
  },
  "description": "Sitemap discovery result for the requested domain, narrowed from the provider's whole result object: the URLs found in the site's sitemap, plus counts of how many sitemaps were found, fetched, and skipped, and whether any sitemap-level errors occurred.",
  "additionalProperties": true
}