Data API / DataForSEO / On Page

OnPage API Waterfall

The load timeline of one crawled url - what was requested, in what order, and how long each took. 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. Use it to explain a slow page; for a scored performance audit instead use post_dataforseo_on_page_lighthouse_live_json. 💰 Free upstream: querying a finished crawl costs nothing, only the crawl itself does.

Параметры

Параметров пути, запроса и заголовков нет.

Тело запроса

idstringОбязательный
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”
urlstringОбязательный
page URL required field specify the pages you want to receive timing for
tagstringНеобязательный
user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response

Пример запроса

curl -X POST "https://openapi.felo.ai/v1/beta/dataforseo/on_page/waterfall" \
  -H "Authorization: Bearer $FELO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "id": "<string>",
  "url": "<string>",
  "tag": "<string>"
}'

Ответ

Поля ответа

versionstringНеобязательный
the current version of the API
status_codeintegerНеобязательный
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_messagestringНеобязательный
general informational message you can find the full list of general informational messages here
timestringНеобязательный
execution time, seconds
costnumberНеобязательный
total tasks cost, USD
tasks_countintegerНеобязательный
the number of tasks in the tasks array
tasks_errorintegerНеобязательный
the number of tasks in the tasks array returned with an error
tasksstring[]Необязательный
array of tasks
idstringНеобязательный
task identifier unique task identifier in our system in the UUID format
status_codeintegerНеобязательный
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
status_messagestringНеобязательный
informational message of the task you can find the full list of general informational messages here
timestringНеобязательный
execution time, seconds
costnumberНеобязательный
cost of the task, USD
result_countintegerНеобязательный
number of elements in the result array
pathstring[]Необязательный
URL path
dataobjectНеобязательный
contains the same parameters that you specified in the POST request
resultstring[]Необязательный
array of results
crawl_progressstringНеобязательный
status of the crawling session possible values: in_progress, finished
crawl_statusobjectНеобязательный
details of the crawling session
max_crawl_pagesintegerНеобязательный
maximum number of pages to crawl indicates the max_crawl_pages limit you specified when setting a task
pages_in_queueintegerНеобязательный
number of pages that are currently in the crawling queue
pages_crawledintegerНеобязательный
number of crawled pages
items_countintegerНеобязательный
number of items in the results array
itemsstring[]Необязательный
items array
page_urlstringНеобязательный
URL of the page
time_to_interactiveintegerНеобязательный
Time To Interactive (TTI) metric the time it takes until the user can interact with a page (in milliseconds)
dom_completeintegerНеобязательный
time to load resources the time it takes until the page and all of its subresources are downloaded (in milliseconds)
connection_timeintegerНеобязательный
time to connect to a server the time it takes until the connection with a server is established (in milliseconds)
time_to_secure_connectionintegerНеобязательный
time to establish a secure connection the time it takes until the secure connection with a server is established (in milliseconds)
request_sent_timeintegerНеобязательный
time to send a request to a server the time it takes until the request to a server is sent (in milliseconds)
waiting_timeintegerНеобязательный
time to first byte (TTFB) in milliseconds
download_timeintegerНеобязательный
time it takes for a browser to receive a response (in milliseconds)
duration_timeintegerНеобязательный
total time it takes until a browser receives a complete response from a server (in milliseconds)
fetch_startintegerНеобязательный
time to start downloading the HTML resource the amount of time the browser needs to start downloading a page
fetch_endintegerНеобязательный
time to complete downloading the HTML resource the amount of time the browser needs to complete downloading a page
resourcesstring[]Необязательный
resource-specific timing contains separate arrays with timing for each resource found on the page
resource_typestringНеобязательный
type of the returned resource
urlstringНеобязательный
resource URL
initiatorstringНеобязательный
resource initiator
duration_timeintegerНеобязательный
total time it takes until a browser receives a complete response from a server (in milliseconds)
fetch_startintegerНеобязательный
time to start downloading the resource the amount of time the browser needs to start downloading a resource
fetch_endintegerНеобязательный
time to complete downloading the resource the amount of time the browser needs to complete downloading a resource
locationobjectНеобязательный
location of the resource in the document parameters defining the location of the specific resource within the document’s HTML
lineintegerНеобязательный
line number the number of the line on which the resource is located
offset_leftintegerНеобязательный
position in line the number of line characters before the resource; sometimes referred to as column Note: counts from 1, i.e. if the resource doesn’t have any characters to the left, the value will be 1
offset_topintegerНеобязательный
position in the document the total number of characters between the resource and the top of HTML
is_render_blockingbooleanНеобязательный
indicates whether the resource blocks rendering