Skip to main content
GET
List Sitemap URLs

Authorizations

X-API-Key
string
header
required

API key for authentication. Get yours from the Promptwatch dashboard under Settings > API Keys.

Query Parameters

filter
enum<string>

Optional. Narrow results: errored (failed/blocked), redirected (3xx with target), inProgress (queued for crawl). Omit to return all crawl-scope URLs.

Available options:
errored,
redirected,
inProgress
page
integer
default:1

Page number (1-based)

Required range: x >= 1
size
integer
default:50

Page size

Required range: 1 <= x <= 100
sortBy
enum<string>
default:lastContentCrawledAt

Field to sort by

Available options:
canonical,
lastContentCrawlHttpStatus,
contentCrawlAttempts,
lastContentCrawledAt,
updatedAt,
createdAt
sortOrder
enum<string>
default:desc

Sort direction

Available options:
asc,
desc
httpStatuses

When filter=errored, restrict to specific HTTP status codes. Repeat the param for multiple values.

Response

Default Response

items
object[]
required
total
integer
required

Total items matching the request

page
integer
required

Page number (1-based)

size
integer
required

Page size

totalPages
integer
required

Total pages for this page size