Get sitemap data

GET

/content/delivery/v1/sitemap

const url = 'https://api.ebitex.io/content/delivery/v1/sitemap';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.ebitex.io/content/delivery/v1/sitemap \
  --header 'Authorization: Bearer <token>'

Every page of one site that belongs in a sitemap, with the path it has in each of the site’s locales and a lastmod. It returns JSON, not XML: render the sitemap with buildSitemapXml from @ebitex/content-sdk/sitemap, which handles absolute URLs, escaping and hreflang.

Only published pages with a real address are listed. Redirects, structural nodes, and pages an editor excluded from search (or whose ancestor is excluded) are omitted. lastmod is when the page’s content last changed, not when it was last published. localeSlots lists the paths a page has; it does not say whether the page has been translated.

With an explicit site and a valid env, the response can be cached at the edge like /sites.

Key: a delivery key (content.delivery.read).

Authorizations

apiKey

Parameters

Query Parameters

site

string format: uuid

env

string format: uuid

Responses

200

400

environment_mismatch: env names a different delivery environment than the key’s.

401

missing_api_key or invalid_api_key: no key was sent, or it is unknown, revoked or expired.

403

scope_denied: the key lacks this route’s scope. origin_denied or ip_denied: a browser-safe key was used from an origin or address outside its restrictions. app_not_available: Content is not enabled for the organization.

404

site_not_found: no site matches site or host.

429

Quota exceeded; Retry-After says how long to wait. too_many_failed_authentications: too many bad keys from this address.