Skip to content

Page tools

Four tools for the pages a project tracks.

List pages in a project, optionally filtered by URL.

NameTypeRequiredNotes
project_idstringyes
url_filterstringnoPartial match against the page URL.
firstnumbernoPage size. Default 20.
afterstringnoOpaque cursor from a prior page’s endCursor.

Returns: { totalCount, pageInfo, pages }.

Returns an error block if your credential cannot reach that project.

Add one or more pages to a project in one call.

NameTypeRequiredNotes
project_idstringyes
urlsstring[]yesAt 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 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.

NameTypeRequiredNotes
page_idsstring[]yesAt least one.

Returns: { deletedCount }, the number of pages deleted.

Without the admin role the call answers an error block and deletes nothing.

Schedule a project’s pages to be re-imported from its sitemap. Requires the admin role.

NameTypeRequiredNotes
project_idstringyes
sitemap_urlstringyesURL of the sitemap to re-import pages from.
scheduledaily | weekly | monthlyyesHow often the sitemap is re-imported.
enabledbooleannoDefault 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.