Skip to content

Sitemap Detail

Returns a single sitemap with its full field set — the data behind the admin Marketing → Search & SEO → Sitemaps view screen.

TIP

New here? Read the Sitemaps overview for what a sitemap does and how its fields behave.

Operation

OperationTypePurpose
adminMarketingSitemapQueryFetch one sitemap by id

Details

  • Requires an admin Bearer token in the Authorization header.
  • Pass the sitemap's IRI (e.g. /api/admin/marketing/sitemaps/1) as the id argument; _id in the response is the numeric id.
  • Unlike list rows, the detail query resolves indexFile and generatedSitemaps — the paths written by the last generate run. Both are null / empty before the sitemap is generated for the first time.

Fields

FieldTypeNotes
idIDThe sitemap's IRI
_idIntNumeric id
fileNameStringIndex file name (ends with .xml)
pathStringDirectory the index file lives in (starts and ends with /)
generatedAtStringTimestamp of the last generate run, or null
indexFileStringPath of the generated index file, or null before first generate
generatedSitemapsArrayPaths of the per-batch product / category / page files; empty before first generate
createdAtStringCreation timestamp
updatedAtStringLast-update timestamp

Released under the MIT License.