BizKitHub
DocsAPI ReferenceVikitron/api/v1/vikitron/crawl-start
postVikitronPublic API v1

/api/v1/vikitron/crawl-start

Idempotently registers a domain as a crawl target and kicks off an immediate crawl. Will not start a second crawl while one is in progress and will not re-run a finished crawl.

vikitronpostApiV1VikitronCrawl-start

Parameters

JSON body

Request body

application/json
domainstringRequired

Domain name (or subdomain) to crawl.

Length: 4–∞
Exampleexample.com

Response schema

1 status code documented

200SuccessCrawl start result.
domainstringRequired

Normalised hostname being crawled (may differ from input after homepage redirects).

domainIdstringRequired

Opaque domain identifier (use for the status endpoint).

inputHoststringRequired

Hostname the caller submitted, after normalisation.

redirectedbooleanRequired

True when the homepage probe followed a same-apex redirect chain.

redirectChainobject[]Required

Same-apex redirect chain followed at start (empty when no redirect).

Each array item:
fromstringRequired

Hostname before this hop.

tostringRequired

Hostname after this hop.

httpCodenumberRequired

HTTP status code that produced this hop.

state"queued" | "running" | "completed"Required

Current crawl state.

startedbooleanRequired

Whether this call actually started a new crawl.

messagestringRequired

Human-readable summary of the action taken.

countsobjectRequired
pendingnumberRequired

URLs waiting to be fetched.

runningnumberRequired

URLs currently being fetched.

oknumberRequired

Successfully fetched URLs (2xx).

errornumberRequired

URLs that failed to fetch.

redirectnumberRequired

URLs that returned a 3xx redirect.

skippednumberRequired

URLs explicitly skipped (e.g. disallowed by robots.txt).

totalnumberRequired

Total URLs discovered so far.

crawlBudgetnumberRequired

Maximum number of URLs the crawler will fetch for this domain.

Response example

application/json
{
  "domain": "example_domain",
  "domainId": "example_domainId",
  "inputHost": "example_inputHost",
  "redirected": false,
  "redirectChain": [
    {
      "from": "example_from",
      "to": "example_to",
      "httpCode": 0
    }
  ],
  "started": false,
  "message": "example_message",
  "counts": {
    "pending": 0,
    "running": 0,
    "ok": 0,
    "error": 0,
    "redirect": 0,
    "skipped": 0,
    "total": 0
  },
  "crawlBudget": 0
}

Request example

POST /api/v1/vikitron/crawl-start

post
curl -X POST "https://api.bizkithub.com/api/v1/vikitron/crawl-start" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "domain": "example.com"
}'

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key