API ReferenceSites

Get saved site

GET
/api/v1/sites/{id}

Authorization

bearerAuth
AuthorizationBearer <token>

API key authentication. Include your API key in the Authorization header as Bearer rf_your_key.

In: header

Path Parameters

id*string

Site ID

Response Body

application/json

application/problem+json

curl -X GET "http://localhost:8080/api/v1/sites/string"
{
  "analysis_result": {
    "detected_elements": [
      {
        "count": 0,
        "description": "string",
        "name": "string",
        "type": "string"
      }
    ],
    "follow_patterns": [
      {
        "description": "string",
        "pattern": "string",
        "sample_urls": [
          "string"
        ]
      }
    ],
    "page_type": "string",
    "recommended_fetch_mode": "string",
    "sample_links": [
      "string"
    ],
    "site_summary": "string",
    "suggested_schema": "string"
  },
  "crawl_options": {
    "follow_pattern": "string",
    "follow_selector": "string",
    "max_depth": 0,
    "max_pages": 0
  },
  "created_at": "string",
  "default_schema_id": "string",
  "domain": "string",
  "fetch_mode": "string",
  "id": "string",
  "name": "string",
  "organization_id": "string",
  "updated_at": "string",
  "url": "string",
  "user_id": "string"
}
{
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "string",
      "message": "string",
      "value": null
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}