Get the status of a crawl job

Request

Authorization

Add parameter in header

x-api-token

Example:

x-api-token: ********************

Path Params

id

string

required

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

Responses

🟢200OK

application/json

Successful response

Body

status

string

optional

The current status of the crawl. Can be scraping, completed, or failed.

total

integer

optional

The total number of pages that were attempted to be crawled.

completed

integer

optional

The number of pages that have been successfully crawled.

data

array [object {6}]

optional

The data of the crawl.

markdown

string

optional

html

string | null

optional

HTML version of the content on page if includeHtml is true

rawHtml

string | null

optional

Raw HTML content of the page if includeRawHtml is true

links

array[string]

optional

List of links on the page if includeLinks is true

screenshot

string | null

optional

Screenshot of the page if includeScreenshot is true

metadata

object

optional

Example

{
    "status": "string",
    "total": 0,
    "completed": 0,
    "data": [
        {
            "markdown": "string",
            "html": "string",
            "rawHtml": "string",
            "links": [
                "string"
            ],
            "screenshot": "string",
            "metadata": {
                "title": "string",
                "description": "string",
                "language": "string",
                "sourceURL": "http://example.com",
                "<any other metadata> ": "string",
                "statusCode": 0,
                "error": "string"
            }
        }
    ]
}

🟠402402

🟠429429

🔴500Server Error