Skip to main content
GET
/
crawl
/
{id}
Get website datasource details
curl --request GET \
  --url https://api.open.cx/crawl/{id}
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "url": "<string>",
  "display_name": "<string>",
  "status": "<string>",
  "page_limit": 123,
  "exclude_paths": [
    "<string>"
  ],
  "include_paths": [
    "<string>"
  ],
  "crawl_interval_hours": 123,
  "last_crawl_started_at": "2023-11-07T05:31:56Z",
  "last_crawl_completed_at": "2023-11-07T05:31:56Z",
  "error_message": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "page_stats": {
    "total": 123,
    "synced": 123,
    "pending": 123,
    "error": 123,
    "excluded": 123
  },
  "active_crawl_job": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "<string>",
    "total_pages": 123,
    "completed_pages": 123,
    "new_pages": 123,
    "updated_pages": 123,
    "removed_pages": 123,
    "unchanged_pages": 123,
    "started_at": "2023-11-07T05:31:56Z"
  }
}

Path Parameters

​
id
string<uuid>
required

The website datasource ID

Response

Default Response

​
id
string<uuid>
required
​
url
string
required
​
display_name
string
required
​
status
string
required
​
page_limit
number | null
required
​
exclude_paths
string[]
required
​
include_paths
string[]
required
​
crawl_interval_hours
number | null
required
​
last_crawl_started_at
string<date-time> | null
required
​
last_crawl_completed_at
string<date-time> | null
required
​
error_message
string | null
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
page_stats
object
required
​
active_crawl_job
object
required