GET
/
v1
/
crawls
/
{crawl_id}
curl --request GET \
  --url https://api.olostep.com/v1/crawls/{crawl_id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "object": "<string>",
  "status": "<string>",
  "created": 123,
  "start_date": "<string>",
  "start_url": "<string>",
  "max_pages": 123,
  "max_depth": 123,
  "exclude_urls": [
    "<string>"
  ],
  "include_urls": [
    "<string>"
  ],
  "include_external": true,
  "search_query": "<string>",
  "top_n": 123,
  "current_depth": 123,
  "pages_count": 123,
  "webhook_url": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
crawl_id
string
required

The ID of the crawl to retrieve information for.

Response

200
application/json
Successful response with crawl information.
​
id
string

Crawl ID

​
object
string

The kind of object. "crawl" for this endpoint.

​
status
string

in_progress or completed

​
created
number

Created time in epoch

​
start_date
string

Created time in date

​
start_url
string
​
max_pages
number
​
max_depth
number
​
exclude_urls
string[]
​
include_urls
string[]
​
include_external
boolean
​
search_query
string
​
top_n
number
​
current_depth
number

The current depth of the crawl process.

​
pages_count
number

Count of pages crawled

​
webhook_url
string
Suggest editsRaise issue