OnPage

‌ Using this function, you can get the overall information on a website as well as drill down into exact on-page issues of a website that has been scanned. As a result, you will know what functions to use for receiving detailed data for each of the found issues.

get/v3/on_page/summary/{id}

Request

  • Base URL: https://api.dataforseo.com
  • URL: https://api.dataforseo.com/v3/on_page/summary/{id}
  • Auth: HTTP basic

Path parameters

idstring required

<em>task identifier</em><br><strong>required field</strong><br>you can get this ID in the response of the <a href="/v3/on_page/task_post/" target="_blank" rel="noopener noreferrer">Task POST</a> endpoint<br>example:<br>“07131248-1535-0216-1000-17384017ad04”

Response

Successful operation

versionstring nullable

the current version of the API

status_codeinteger nullable

general status code you can find the full list of the response codes here

status_messagestring nullable

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

timestring nullable

total execution time, seconds

costnumber double nullable

total tasks cost, USD

tasks_countinteger nullable

the number of tasks in the tasks array

tasks_errorinteger nullable

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

Changes

    • breaking

      the /////////////////////// response's property type changed from integer to number for status

    • info

      added the optional property /////////////////////// to the response with the status