crawls

Get a crawl

Retrieve status and progress information about a crawl.

get/v1/crawls/{crawlId}

Request

  • Base URL: https://api.olostep.com
  • URL: https://api.olostep.com/v1/crawls/{crawlId}
  • Auth: HTTP bearer

Path parameters

crawlIdstring required

Response

Default Response

idstring required
object'crawl' required
statusstring required
creatednumber required
start_datestring
start_urlstring required
max_pagesnumber nullable
max_depthnumber nullable
exclude_urlsstring[]
include_urlsstring[]
include_externalboolean
search_querystring
top_nnumber
current_depthnumber
pages_countnumber
webhookstring nullable
webhook_urlstring nullable
follow_robots_txtboolean
credits_consumednumber nullable
cost_usdnumber nullable

Changes

No recorded changes to this operation across all 3 revisions of this API.