Skip to main content
GET
/
v1
/
crawl
/
{id}
Crawl by ID
curl --request GET \
  --url https://sdk.nimbleway.com/v1/crawl/{id} \
  --header 'Authorization: Bearer <token>'
{
  "status": true,
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "total": 123,
  "completed": 123,
  "created_at": "<string>",
  "completed_at": "<string>",
  "tasks": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "url": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string<uuid>
required

The unique identifier of the crawl task

Example:

"123e4567-e89b-12d3-a456-426614174000"

Response

Successful Response

​
status
boolean
required

Status of the crawl task

Example:

true

​
id
string<uuid>
required

Unique identifier for the crawl task

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
name
string
required

Name of the crawl task

​
total
integer
required

Total number of pages to crawl

Example:

10

​
completed
integer
required

Number of pages completed

Example:

2

​
created_at
string
required

Timestamp when crawl was created

​
completed_at
string
required

Timestamp when crawl was completed

​
tasks
object[]
required

Array of individual page crawl tasks