Skip to main content
POST
https://api.evergreens.ai
/
v1
/
networks
/
browser
/
sitemap
{
  "sort": "asc",
  "type": "absolute",
  "urls": [
    "https://evergreen.media"
  ]
}

{
  "status": true,
  "data": {
    "isCached": false,
    "cacheExpiresIn": null,
    "results": {
      "https://evergreen.media": {
        "live": {
          "totalUrls": 330,
          "totalParts": 0,
          "partSize": 100000,
          "parts": [],
          "urls": [
            "https://www.evergreen.media/workshops/",
            "https://www.evergreen.media/whitepaper/",
            "https://www.evergreen.media/warum-ist-seo-wichtig/",
            "https://www.evergreen.media/ueber-uns/vision-mission/",
            "https://www.evergreen.media/ueber-uns/unsere-werte/"
            // ... more URLs
          ]
        },
        "dead": {
          "totalUrls": 0,
          "urls": []
        },
        "metrics": {
          "discovered": 330,
          "live": 330,
          "dead": 0,
          "validated": false,
          "processingTimeMs": 637
        },
        "fileTypes": ["txt"],
        "expiresIn": null,
        "expiresInDate": null
      }
    }
  }
}
Extract and manage website sitemaps efficiently using the Browser network component. Even when no sitemap.xml file is available or no sitemap entry exists in robots.txt, our system can intelligently discover and compile a comprehensive sitemap for the target website. Entity Reference:
SitemapEntity

​
Request

​
urls
string[]
required
An array of URLs from which to extract sitemap elements.
  • Minimum: 1 URL per request
  • Maximum: 10 URLs per request
​
sort
'asc' | 'desc'
default:"asc"
Specifies the sorting order of URLs in the sitemap.
  • 'asc' for ascending order (default)
  • 'desc' for descending order
​
type
'absolute' | 'relative'
default:"absolute"
Determines whether URLs are returned as absolute or relative paths.
  • 'absolute' for complete URLs (default), e.g., https://example.com/page
  • 'relative' for domain-relative paths, e.g., /page
​
pathCase
lowercase|uppercase|capitalize|as-is
default:"as-is"
Specifies the casing for the sitemap URLs.
  • lowercase: Converts all URLs to lowercase.
  • uppercase: Converts all URLs to uppercase.
  • capitalize: Capitalizes the first letter of each URL segment.
  • as-is: Retains the original casing of the URLs (default).
​
validateUrls
boolean
default:false
If set to true, the system will validate each extracted URL to ensure it is reachable, such as detecting broken links or dead ends.
  • Default is false, meaning no validation is performed.
​
includeDeadUrls
boolean
default:false
When validateUrls is enabled, setting this to true will include URLs that are found to be dead or unreachable in the sitemap results.
  • Default is false, meaning dead URLs will be excluded from the results.
​
include
MetadataEntity[]
An optional object specifying additional metadata fields to include for each sitemap URL. default: none (only URLs are returned).See MetadataEntity for available fields.
Note: Including metadata fields may increase processing time and resource consumption.
​
cache
object
An optional object to configure caching behavior for the request. By default, caching is enabled with a TTL of 120 seconds. You can customize these settings by providing the cache object.

​
Response

​
isCached
boolean
default:true
Indicates whether the response was served from cache.
​
cacheExpiresIn
number
default:7200
The time in seconds until the cached response expires. Default is 7200 seconds (2 hours).
​
results
required
An object where each key is a requested URL and the value contains categorized sitemap data with live URLs, dead URLs (if validation enabled), and extraction metrics.
{
  "sort": "asc",
  "type": "absolute",
  "urls": [
    "https://evergreen.media"
  ]
}

{
  "status": true,
  "data": {
    "isCached": false,
    "cacheExpiresIn": null,
    "results": {
      "https://evergreen.media": {
        "live": {
          "totalUrls": 330,
          "totalParts": 0,
          "partSize": 100000,
          "parts": [],
          "urls": [
            "https://www.evergreen.media/workshops/",
            "https://www.evergreen.media/whitepaper/",
            "https://www.evergreen.media/warum-ist-seo-wichtig/",
            "https://www.evergreen.media/ueber-uns/vision-mission/",
            "https://www.evergreen.media/ueber-uns/unsere-werte/"
            // ... more URLs
          ]
        },
        "dead": {
          "totalUrls": 0,
          "urls": []
        },
        "metrics": {
          "discovered": 330,
          "live": 330,
          "dead": 0,
          "validated": false,
          "processingTimeMs": 637
        },
        "fileTypes": ["txt"],
        "expiresIn": null,
        "expiresInDate": null
      }
    }
  }
}