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>'
{
  "crawl_id": "85b21e98-69c5-4aa5-9d25-261a55bbf0db",
  "name": "my-crawler-1",
  "url": "https://www.amazon.com/dp",
  "account_name": "account_name",
  "status": "succeeded",
  "completed_at": "2026-02-11T13:57:27.549Z",
  "crawl_options": {
    "limit": 10,
    "sitemap": "include",
    "allow_subdomains": false,
    "crawl_entire_domain": false,
    "max_discovery_depth": 5,
    "allow_external_links": false,
    "ignore_query_parameters": false
  },
  "extract_options": null,
  "created_at": "2026-02-11T13:55:45.512Z",
  "updated_at": "2026-02-11T13:57:27.555Z",
  "pending": 0,
  "completed": 3,
  "failed": 1,
  "total": 4,
  "tasks": [
    {
      "task_id": "8d2bb2fc-e469-4549-b5d8-0d307352aeb5",
      "status": "completed",
      "created_at": "2026-02-11T13:55:45.846Z",
      "updated_at": "2026-02-11T13:55:52.138Z"
    },
    {
      "task_id": "f1fc1a7d-588b-4c9c-b6f3-00a00b6796ce",
      "status": "completed",
      "created_at": "2026-02-11T13:55:52.115Z",
      "updated_at": "2026-02-11T13:55:53.335Z"
    },
    {
      "task_id": "79389a76-7c7f-4d6d-9041-c13ff83dc265",
      "status": "completed",
      "created_at": "2026-02-11T13:55:52.115Z",
      "updated_at": "2026-02-11T13:55:53.858Z"
    },
    {
      "task_id": "7f10be27-a526-4cbb-8330-53c7871e7572",
      "status": "failed",
      "created_at": "2026-02-11T13:55:46.075Z",
      "updated_at": "2026-02-11T13:57:27.534Z"
    }
  ]
}

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
string
required

Status of the crawl task

Example:

"succeeded"

​
crawl_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

​
account_name
string

The user's account name

​
failed
integer

Number of pages failed

Example:

2

​
pending
integer

Number of pages pending

Example:

2

​
updated_at
string

Timestamp when crawl was updateded