Poll a crawl (kept for 24 hours)

get/v1/crawl/{id}

Request

  • Base URL: https://api.serpkite.com
  • URL: https://api.serpkite.com/v1/crawl/{id}
  • Auth: HTTP bearer

Response

OK

idstring uuid required
kind'crawl' required
status'queued' | 'running' | 'completed' | 'failed' | 'canceled' required
created_atstring date-time required
started_atstring date-time nullable
completed_atstring date-time nullable
credits_reservednumber required
credits_usednumber required
webhook_status'pending' | 'delivered' | 'failed' | 'null' nullable

Example response

{
  "result": {
    "pages": [
      {
        "metadata": {
          "content_type": "text/html"
        }
      }
    ],
    "failed": [
      {
        "error": {
          "code": "invalid_request"
        }
      }
    ]
  },
  "error": {
    "code": "no_pages"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.