Reference
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
url |
string | yes | Site URL or a full path to a map. For a site URL, sitemap.xml, sitemap_index.xml and wp-sitemap.xml are tried. |
Example request
curl -s "https://api2.globus.studio/v2/sitemap?url=https://globus.studio/"
A sitemap is only useful if it parses. One broken child map, a stale index or a gzip file served with the wrong header removes pages from the crawl queue without any visible symptom. This endpoint reads the index, follows the child maps and reports what it found.
What it counts
The response returns the map type, the list of maps with their own status and URL count, the total number of URLs, how many of them carry lastmod, and the oldest and newest date in the set. The lastmod range is the quickest way to see a map that stopped updating months ago.
curl -s "https://api2.globus.studio/v2/sitemap?url=https%3A%2F%2Fglobus.studio%2F"Errors stay inside the answer
A child map that answers 500, returns HTML instead of XML or uses an unknown root element does not fail the whole request. It lands in errors with the reason, and the rest of the index is still counted. That matters for a monitor: one dead map should not hide the other nine.
For a site root the endpoint tries /sitemap.xml, then /sitemap_index.xml, then /wp-sitemap.xml, and stops at the first map that answers 200.
Limits
Ten maps and three levels of nesting, 8 MB per map, one hour of cache. Compressed .gz files are reported with compressed: true and are not unpacked, because the server does not promise the zlib extension.
Related
The full parameter table, every error code and a live request are on the documentation page. It opens in the same language as this page and needs no account.
A longer walkthrough, with the checks that matter and the limits worth planning for: A sitemap that parses: counting URLs and finding dead maps.