Query the page tree

GET

/content/delivery/v1/nodes

const url = 'https://api.ebitex.io/content/delivery/v1/nodes';
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/nodes \
  --header 'Authorization: Bearer <token>'

The published page tree, for navigation: a breadcrumb, a section menu, a previous/next pager or a whole-site tree are each one request.

from is the anchor, a node id or a published path; the default is the site root.
include is repeatable: ancestors, self, children, siblings and descendants (default self,descendants).
maxDepth bounds descendants, counted from the site root.

Nodes come back flat and parent-linked, in depth-first order with siblings in their authored order. Each has a kind: presentation (a page), redirect (with targetNodeId, and targetPath when that target is published), or structural (an address with nothing to serve). title is never empty: it falls back to the node’s own name, and titleSource says which answered.

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

Authorizations

apiKey

Parameters

Query Parameters

site

string format: uuid

host

string

from

string

include

Array<string>

maxDepth

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

locale

string

Responses

200

400

validation_failed: an unknown include value or a negative maxDepth. tree_too_large: over 5,000 nodes; narrow it with from, include or maxDepth.

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. node_not_found: from names nothing published in that site.

429

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