Preview sitemap URLs
POST
Preview sitemap URLs

Authorizations

Authorization
string
header
required

Voiceflow bearer token

Query Parameters

projectID
string
required

The ID of the project to operate on.

Body

sitemapURL
string
required

The HTTPS URL of the sitemap to read. A bare site URL works too — when it does not end in .xml, /sitemap.xml, /sitemap_index.xml and /sitemap/sitemap.xml are probed in turn.

exclude
string[]

Patterns that drop a URL from the import when any one of them matches. Matching is case-insensitive and unanchored: a pattern with no * matches any URL containing it as a substring (/blog/), while * matches any run of characters (*/tag/*, *.pdf).

Response

200 - application/json

Returns the URLs an import would create, the total the sitemap yields after exclude, the per-import limit, whether the list was truncated, and the counts excluded and dropped.

urls
string[]
required

The URLs that would be imported, in sitemap order, capped at limit entries.

total
number
required

How many URLs the sitemap yields once exclude is applied, before the cap.

limit
number
required

The most URL documents this plan allows in a single import.

truncated
boolean
required

True when total is above limit, meaning urls is only part of what the sitemap holds.

excluded
number
required

How many valid URLs the exclude patterns removed. Zero when no patterns were given.

dropped
number
required

How many entries the sitemap listed that are not usable URLs and were skipped.

Use the up and down arrow keys to select a result, Enter to open it, and Escape to close the search.