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.

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

Endpoint

EndpointMethod
/api/admin/marketing/sitemaps/{id}GET

Details

  • Requires an admin Bearer token in the Authorization header.
  • Unlike list rows, the detail endpoint returns generatedFiles — the actual XML files produced by the last generate run, one entry per channel.
  • generatedFiles is empty until the sitemap has been generated at least once.
  • An unknown id returns a 404.

Response fields

FieldTypeNotes
idintNumeric id
fileNamestringIndex file name (ends with .xml)
pathstringPath where the index file is written (starts and ends with /)
channelsinteger[]Channel ids the sitemap covers
urlsstring[]Public index URL per channel — the link to submit to a search engine
generatedAtstringTimestamp of the last generate run, or null
generatedFilesobject[]What the last run wrote, one entry per channel: channelId, channelCode, hostname, index, sitemaps[]
indexFilestringIndex path of a sitemap generated before generation became channel-aware. null for anything generated since — read generatedFiles
generatedSitemapsstring[]Child paths of a sitemap generated before generation became channel-aware. Empty for anything generated since — read generatedFiles
createdAtstringCreation timestamp
updatedAtstringLast-update timestamp

Released under the MIT License.