Get Page Hierarchy
AI-generatedOverview
This node interacts with Confluence API v2 to retrieve page hierarchies within a specified Confluence space. It supports fetching pages in a hierarchical structure, allowing users to control the depth of the hierarchy fetched, either fully or limited to a specified maximum depth. This is useful for scenarios where users need to visualize or process the nested structure of pages in a Confluence space, such as generating site maps, auditing content organization, or migrating content.
Use Case Examples
- Fetch the entire page hierarchy of a Confluence space to analyze the nested page structure.
- Limit the depth of the page hierarchy to 3 levels to get a summarized view of the space's content organization.
Properties
| Name | Meaning |
|---|---|
| Space ID | The ID of the Confluence space to fetch the page hierarchy from. |
| Depth Control | Controls how deep the page hierarchy is fetched: either full depth (no limit) or limited to a maximum depth. |
| Max Depth | The maximum depth to fetch in the hierarchy when depth control is set to limited. A value of 1 means only direct children are fetched. |
| Limit | Maximum number of pages to return per request, up to 250. |
Output
JSON
json- The hierarchical structure of pages fetched from the Confluence space. Each page object may contain nested child pages representing the hierarchy.
Dependencies
- Requires an API key credential for Confluence API v2 authentication.
Troubleshooting
- Common issues include invalid or missing Space ID, which will cause the API call to fail. Ensure the Space ID is correct and accessible with the provided credentials.
- If the depth control is set to limited but the max depth is set too low, the hierarchy may appear incomplete. Adjust the max depth accordingly.
- API rate limits or network issues may cause request failures. Check network connectivity and API usage limits.
- Error messages from the API are propagated; enabling 'continue on fail' allows the node to continue processing other items even if some fail.
Links
- Confluence Cloud REST API - Spaces - Official documentation for Confluence API spaces endpoint, useful for understanding space and page retrieval.
- Confluence Cloud REST API - Content - Official documentation for Confluence API content endpoint, relevant for fetching pages and their hierarchy.