Sitemap

Get sitemap job status

Return a sitemap job's status and progress. Poll it after approveSitemapJob until the status is completed, failed, canceled or token_cap_exceeded. Also served under /map with the same shapes.

get/sitemap/{jobId}

Request

  • Base URL: https://request.usestring.ai/v1
  • URL: https://request.usestring.ai/v1/sitemap/{jobId}
  • Auth: HTTP bearer

Response

Status returned.

jobIdstring required
status'awaiting_approval' | 'running' | 'completed' | 'failed' | 'canceled' | 'token_cap_exceeded' required

Job status.

estimatedCostUsdstring

Quoted cost in USD, as a decimal string.

pendinginteger

Queued URLs.

processedinteger

URLs crawled so far.

pagesProcessedinteger
errorMessagestring

Why the job failed, for example quote_expired.

finishedAtstring date-time

Changes

No recorded changes to this operation across all 1 revision of this API.