Felo API PlatformFelo API Platform
v0.1.0-beta
OpenAPI 3.1.0

OnPage API Raw HTML

Server:https://openapi.felo.ai
Client Libraries

DataForSEO

​

SEO, search-engine results, keyword research, backlinks and AI visibility data.

OnPage API Raw HTML

​

The stored HTML of one crawled url. Reads a finished crawl, so it needs the id from post_dataforseo_on_page_submit and returns crawl_progress plus a crawl_status of max_crawl_pages, pages_in_queue and pages_crawled - check those before trusting a small result, because a crawl still running simply has less to report. ⚠️ Only available if the crawl was submitted with store_raw_html set - otherwise there is nothing to return, and the crawl cannot be amended after the fact. For parsed content rather than source use post_dataforseo_on_page_content_parsing. 💰 Free upstream: querying a finished crawl costs nothing, only the crawl itself does.

Body
required
application/json
  • Type: array object[]
    • id
      Type: string
      required

      ID of the task required field you can get this ID in the response of the Task POST endpoint example: “07131248-1535-0216-1000-17384017ad04”

    • url
      Type: string

      page url required field the absolute URL of a page to request HTML Note: this field is optional if the task was set using the Instant Pages endpoint

Responses
  • 200
    Type: object

    Successful response

    • cost
      Type: number

      total tasks cost, USD

    • status_code
      Type: integer

      general status code you can find the full list of the response codes here Note: we strongly recommend designing a necessary system for handling related exceptional or error conditions

    • status_message
      Type: string

      general informational message you can find the full list of general informational messages here

    • tasks
      Type: array string[]

      array of tasks

    • tasks_count
      Type: integer

      the number of tasks in the tasks array

    • tasks_error
      Type: integer

      the number of tasks in the tasks array returned with an error

    • tasks.cost
      Type: number

      cost of the task, USD

    • tasks.data
      Type: object

      contains the same parameters that you specified in the POST request

    • tasks.id
      Type: string

      task identifier unique task identifier in our system in the UUID format

    • tasks.path
      Type: array string[]

      URL path

    • tasks.result
      Type: array string[]

      array of results

    • tasks.result_count
      Type: integer

      number of elements in the result array

    • tasks.result.crawl_progress
      Type: string

      status of the crawling session possible values: in_progress, finished

    • tasks.result.crawl_status
      Type: object

      details of the crawling session

    • tasks.result.crawl_status.max_crawl_pages
      Type: integer

      maximum number of pages to crawl indicates the max_crawl_pages limit you specified when setting a task

    • tasks.result.crawl_status.pages_crawled
      Type: integer

      number of crawled pages

    • tasks.result.crawl_status.pages_in_queue
      Type: integer

      number of pages that are currently in the crawling queue

    • tasks.result.items
      Type: object

      items object

    • tasks.result.items_count
      Type: integer

      number of items in the results array

    • tasks.result.items.html
      Type: string

      HTML page

    • tasks.status_code
      Type: integer

      status code of the task generated by DataForSEO; can be within the following range: 10000-60000 you can find the full list of the response codes here

    • tasks.status_message
      Type: string

      informational message of the task you can find the full list of general informational messages here

    • tasks.time
      Type: string

      execution time, seconds

    • time
      Type: string

      execution time, seconds

    • version
      Type: string

      the current version of the API

    application/json
  • 400

    Bad request

  • 401

    Unauthorized

  • 402

    The request cannot proceed because a billing requirement is not met.

  • 403

    The account is not permitted to perform this operation.

  • 429

    Rate limit exceeded

  • 500

    Internal server error

  • 502

    The service could not complete the request.

  • 503

    The API or billing service is temporarily unavailable.

  • 504

    The service timed out while processing the request.

  • default

    The operation failed. Keep the response request ID when contacting Felo support.

Request Example for post/v1/beta/dataforseo/on_page/raw_html
curl https://openapi.felo.ai/v1/beta/dataforseo/on_page/raw_html \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '[
  {
    "id": "",
    "url": ""
  }
]'
{
  "version": "string",
  "status_code": 1,
  "status_message": "string",
  "time": "string",
  "cost": 1,
  "tasks_count": 1,
  "tasks_error": 1,
  "tasks": [
    "string"
  ],
  "tasks.id": "string",
  "tasks.status_code": 1,
  "tasks.status_message": "string",
  "tasks.time": "string",
  "tasks.cost": 1,
  "tasks.result_count": 1,
  "tasks.path": [
    "string"
  ],
  "tasks.data": {},
  "tasks.result": [
    "string"
  ],
  "tasks.result.crawl_progress": "string",
  "tasks.result.crawl_status": {},
  "tasks.result.crawl_status.max_crawl_pages": 1,
  "tasks.result.crawl_status.pages_in_queue": 1,
  "tasks.result.crawl_status.pages_crawled": 1,
  "tasks.result.items_count": 1,
  "tasks.result.items": {},
  "tasks.result.items.html": "string"
}
OnPage API Raw HTML