Page tools
Four tools for the pages a project tracks.
list_pages
Section titled “list_pages”List pages in a project, optionally filtered by URL.
| Name | Type | Required | Notes |
|---|---|---|---|
project_id | string | yes | |
url_filter | string | no | Partial match against the page URL. |
first | number | no | Page size. Default 20. |
after | string | no | Opaque cursor from a prior page’s endCursor. |
Returns: { totalCount, pageInfo, pages }.
Returns an error block if your credential cannot reach that project.
create_page
Section titled “create_page”Add one or more pages to a project in one call.
| Name | Type | Required | Notes |
|---|---|---|---|
project_id | string | yes | |
urls | string[] | yes | At least one, e.g. ["https://example.com/about"]. |
Returns: { pages, imported, skippedDueToQuota }. pages lists the id, url and
createdAt of each page your URLs name, including any the project already had. imported counts
the pages this call added. skippedDueToQuota counts the new URLs left out because the project
reached its page limit or the plan’s page allowance for the period ran out. A URL outside the
project’s site is dropped.
To add every page a sitemap lists, use import_sitemap instead.
delete_page
Section titled “delete_page”Delete pages by their raw or GraphQL global IDs. Existing pages must share an organization where the caller is an admin or owner. They may span projects. Missing IDs are ignored.
| Name | Type | Required | Notes |
|---|---|---|---|
page_ids | string[] | yes | At least one. |
Returns: { deletedCount }, the number of pages deleted.
Without the admin role the call answers an error block and deletes nothing.
configure_project_sitemap
Section titled “configure_project_sitemap”Schedule a project’s pages to be re-imported from its sitemap. Requires the admin role.
| Name | Type | Required | Notes |
|---|---|---|---|
project_id | string | yes | |
sitemap_url | string | yes | URL of the sitemap to re-import pages from. |
schedule | daily | weekly | monthly | yes | How often the sitemap is re-imported. |
enabled | boolean | no | Default true. Pass false to pause re-imports and keep the settings. |
The call replaces the project’s whole sitemap setting. The server refuses a sitemap_url that is
not a public http or https URL. See Vocabularies.
To import a sitemap once, now, use import_sitemap.
Returns: the project’s id, name and config.sitemap: sitemapUrl, schedule, enabled
and lastRun.