v0.1.0-beta

OpenAPI 3.1.0

OnPage API Waterfall

Felo API Support

MIT

Сервер

https://openapi.felo.ai

Клиентские библиотеки

Shell Curl

DataForSEO

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

DataForSEO Операции

post/v1/beta/dataforseo/on_page/waterfall

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.

Тело

обязательно

application/json

Тип: array object[]
- id
  Тип: string
  обязательно
  
  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
  Тип: string
  обязательно
  
  page URL required field specify the pages you want to receive timing for
- tag
  Тип: string
  
  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

Ответы

200
Тип: object

Successful response
cost
Тип: number

total tasks cost, USD

status_code
Тип: 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
Тип: string

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

tasks
Тип: array string[]

array of tasks

tasks_count
Тип: integer

the number of tasks in the tasks array

tasks_error
Тип: integer

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

tasks.cost
Тип: number

cost of the task, USD

tasks.data
Тип: object

contains the same parameters that you specified in the POST request

tasks.id
Тип: string

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

tasks.path
Тип: array string[]

URL path

tasks.result
Тип: array string[]

array of results

tasks.result_count
Тип: integer

number of elements in the result array

tasks.result.crawl_progress
Тип: string

status of the crawling session possible values: in_progress, finished

tasks.result.crawl_status
Тип: object

details of the crawling session

tasks.result.crawl_status.max_crawl_pages
Тип: 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
Тип: integer

number of crawled pages

tasks.result.crawl_status.pages_in_queue
Тип: integer

number of pages that are currently in the crawling queue

tasks.result.items
Тип: array string[]

items array

tasks.result.items_count
Тип: integer

number of items in the results array

tasks.result.items.connection_time
Тип: integer

time to connect to a server the time it takes until the connection with a server is established (in milliseconds)

tasks.result.items.dom_complete
Тип: integer

time to load resources the time it takes until the page and all of its subresources are downloaded (in milliseconds)

tasks.result.items.download_time
Тип: integer

time it takes for a browser to receive a response (in milliseconds)

tasks.result.items.duration_time
Тип: integer

total time it takes until a browser receives a complete response from a server (in milliseconds)

tasks.result.items.fetch_end
Тип: integer

time to complete downloading the HTML resource the amount of time the browser needs to complete downloading a page

tasks.result.items.fetch_start
Тип: integer

time to start downloading the HTML resource the amount of time the browser needs to start downloading a page

tasks.result.items.page_url
Тип: string

URL of the page

tasks.result.items.request_sent_time
Тип: integer

time to send a request to a server the time it takes until the request to a server is sent (in milliseconds)

tasks.result.items.resources
Тип: array string[]

resource-specific timing contains separate arrays with timing for each resource found on the page

tasks.result.items.resources.duration_time
Тип: integer

total time it takes until a browser receives a complete response from a server (in milliseconds)

tasks.result.items.resources.fetch_end
Тип: integer

time to complete downloading the resource the amount of time the browser needs to complete downloading a resource

tasks.result.items.resources.fetch_start
Тип: integer

time to start downloading the resource the amount of time the browser needs to start downloading a resource

tasks.result.items.resources.initiator
Тип: string

resource initiator

tasks.result.items.resources.is_render_blocking
Тип: boolean

indicates whether the resource blocks rendering

tasks.result.items.resources.location
Тип: object

location of the resource in the document parameters defining the location of the specific resource within the document’s HTML

tasks.result.items.resources.location.line
Тип: integer

line number the number of the line on which the resource is located

tasks.result.items.resources.location.offset_left
Тип: integer

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

tasks.result.items.resources.location.offset_top
Тип: integer

position in the document the total number of characters between the resource and the top of HTML

tasks.result.items.resources.resource_type
Тип: string

type of the returned resource

tasks.result.items.resources.url
Тип: string

resource URL

tasks.result.items.time_to_interactive
Тип: integer

Time To Interactive (TTI) metric the time it takes until the user can interact with a page (in milliseconds)

tasks.result.items.time_to_secure_connection
Тип: integer

time to establish a secure connection the time it takes until the secure connection with a server is established (in milliseconds)

tasks.result.items.waiting_time
Тип: integer

time to first byte (TTFB) in milliseconds

tasks.status_code
Тип: 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
Тип: string

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

tasks.time
Тип: string

execution time, seconds

time
Тип: string

execution time, seconds

version
Тип: 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.

post/v1/beta/dataforseo/on_page/waterfall

curl https://openapi.felo.ai/v1/beta/dataforseo/on_page/waterfall \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '[
  {
    "id": "",
    "url": "",
    "tag": ""
  }
]'

Показать схему

{
  "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": [
    "string"
  ],
  "tasks.result.items.page_url": "string",
  "tasks.result.items.time_to_interactive": 1,
  "tasks.result.items.dom_complete": 1,
  "tasks.result.items.connection_time": 1,
  "tasks.result.items.time_to_secure_connection": 1,
  "tasks.result.items.request_sent_time": 1,
  "tasks.result.items.waiting_time": 1,
  "tasks.result.items.download_time": 1,
  "tasks.result.items.duration_time": 1,
  "tasks.result.items.fetch_start": 1,
  "tasks.result.items.fetch_end": 1,
  "tasks.result.items.resources": [
    "string"
  ],
  "tasks.result.items.resources.resource_type": "string",
  "tasks.result.items.resources.url": "string",
  "tasks.result.items.resources.initiator": "string",
  "tasks.result.items.resources.duration_time": 1,
  "tasks.result.items.resources.fetch_start": 1,
  "tasks.result.items.resources.fetch_end": 1,
  "tasks.result.items.resources.location": {},
  "tasks.result.items.resources.location.line": 1,
  "tasks.result.items.resources.location.offset_left": 1,
  "tasks.result.items.resources.location.offset_top": 1,
  "tasks.result.items.resources.is_render_blocking": true
}

Successful response

OnPage API Waterfall

АутентификацияRequired

DataForSEO

OnPage API Waterfall