Crawl

List Crawls

GET
/v2/crawl

Authorization

BearerAuth
AuthorizationBearer <token>

In: header

Query Parameters

status?string

Filter crawls by their status.

Default"all"

Value in

  • "queued"
  • "running"
  • "succeeded"
  • "failed"
  • "canceled"
  • "all"
cursor?|

Cursor for pagination.

Defaultnull
limit?integer

Number of crawls to return per page.

Range1 <= value <= 9007199254740991
Default100

Response Body

application/json

curl -X GET "https://example.com/v2/crawl"
{  "data": [    {      "account_name": "string",      "completed": 0,      "completed_at": "string",      "crawl_id": "c9eee371-0b50-4a83-baff-95c2f0e36a00",      "crawl_options": {        "allow_external_links": false,        "allow_subdomains": false,        "callback": {          "events": [            "started"          ],          "headers": {            "property1": "string",            "property2": "string"          },          "metadata": {            "property1": null,            "property2": null          },          "url": "http://example.com"        },        "crawl_entire_domain": false,        "exclude_paths": [          "string"        ],        "ignore_query_parameters": false,        "include_paths": [          "string"        ],        "limit": 5000,        "max_discovery_depth": 5,        "sitemap": "skip",        "property1": null,        "property2": null      },      "created_at": "string",      "extract_options": {        "property1": null,        "property2": null      },      "failed": 0,      "name": "string",      "pending": 0,      "status": "queued",      "tasks": [        {          "created_at": "string",          "status": "pending",          "task_id": "string",          "updated_at": "string"        }      ],      "total": 0,      "updated_at": "string",      "url": "http://example.com"    }  ],  "pagination": {    "has_next": true,    "next_cursor": "string",    "total": 0  }}