データ 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