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
| Operation | Type | Purpose |
|---|---|---|
adminMarketingSitemap | Query | Fetch one sitemap by id |
Details
- Requires an admin Bearer token in the
Authorizationheader. - Pass the sitemap's IRI (e.g.
/api/admin/marketing/sitemaps/1) as theidargument;_idin the response is the numeric id. - Unlike list rows, the detail query resolves
indexFileandgeneratedSitemaps— the paths written by the last generate run. Both arenull/ empty before the sitemap is generated for the first time.
Fields
| Field | Type | Notes |
|---|---|---|
id | ID | The sitemap's IRI |
_id | Int | Numeric id |
fileName | String | Index file name (ends with .xml) |
path | String | Directory the index file lives in (starts and ends with /) |
generatedAt | String | Timestamp of the last generate run, or null |
indexFile | String | Path of the generated index file, or null before first generate |
generatedSitemaps | Array | Paths of the per-batch product / category / page files; empty before first generate |
createdAt | String | Creation timestamp |
updatedAt | String | Last-update timestamp |

