NAVNavbar
Logo
cURL php NodeJS Python cSharp

OnPage API Waterfall

‌‌
This endpoint is designed to provide you with the page speed insights. Using this function you can get detailed information about the page loading time, time to secure connection, the time it takes to load page resources, and so on.

This feature is especially useful for creating page speed tests and other tools for checking website performance.

Instead of ‘login’ and ‘password’ use your credentials from https://app.dataforseo.com/api-dashboard

<?php
// You can download this file from here https://cdn.dataforseo.com/v3/examples/php/php_RestClient.zip
require('RestClient.php');
$api_url = 'https://api.dataforseo.com/';
// Instead of 'login' and 'password' use your credentials from https://app.dataforseo.com/api-dashboard
$client = new RestClient($api_url, null, 'login', 'password');

$post_array = array();
// simple way to get a result
$post_array[] = array(
   "id" => "07281559-0695-0216-0000-c269be8b7592",
   "url" => "https://dataforseo.com/tag/broken-links"
);
try {
   // POST /v3/on_page/waterfall
   // the full list of possible parameters is available in documentation
   $result = $client->post('/v3/on_page/waterfall', $post_array);
   print_r($result);
   // do something with post result
} catch (RestClientException $e) {
   echo "\n";
   print "HTTP code: {$e->getHttpCode()}\n";
   print "Error code: {$e->getCode()}\n";
   print "Message: {$e->getMessage()}\n";
   print  $e->getTraceAsString();
   echo "\n";
}
$client = null;
?>

The above command returns JSON structured like this:

{
  "version": "0.1.20210917",
  "status_code": 20000,
  "status_message": "Ok.",
  "time": "15.5789 sec.",
  "cost": 0,
  "tasks_count": 1,
  "tasks_error": 0,
  "tasks": [
    {
      "id": "11051336-1535-0216-0000-c24c3882222d",
      "status_code": 20000,
      "status_message": "Ok.",
      "time": "11.9290 sec.",
      "cost": 0,
      "result_count": 1,
      "path": [
        "v3",
        "on_page",
        "waterfall"
      ],
      "data": {
        "api": "on_page",
        "function": "waterfall",
        "url": "https://dataforseo.com/help-center",
        "target": "dataforseo.com",
        "max_crawl_pages": 100,
        "load_resources": true,
        "store_raw_html": true,
        "enable_javascript": true,
        "enable_xhr": true,
        "enable_browser_rendering": true,
        "allow_subdomains": true
      },
      "result": [
        {
          "crawl_progress": "finished",
          "crawl_status": {
            "max_crawl_pages": 100,
            "pages_in_queue": 0,
            "pages_crawled": 100
          },
          "items_count": 1,
          "items": [
            {
              "page_url": "https://dataforseo.com/help-center",
              "time_to_interactive": 3268,
              "dom_complete": 3629,
              "connection_time": 0,
              "time_to_secure_connection": 0,
              "request_sent_time": 0,
              "waiting_time": 0,
              "download_time": 0,
              "duration_time": 0,
              "fetch_start": 0,
              "fetch_end": 0,
              "resources": [
                {
                  "url": "https://dataforseo.com/wp-content/plugins/dataforseo-reload-robots/assets/css/style.css?ver=5.8.1",
                  "initiator": "(index)",
                  "duration_time": 35,
                  "fetch_start": 0,
                  "fetch_end": 35,
                  "location": {
                    "line": 48,
                    "offset_left": 1,
                    "offset_top": 23033
                  }
                },
                {
                  "url": "https://dataforseo.com/wp-content/plugins/wp-video-lightbox/css/prettyPhoto.css?ver=5.8.1",
                  "initiator": "(index)",
                  "duration_time": 43,
                  "fetch_start": 0,
                  "fetch_end": 43,
                  "location": {
                    "line": 50,
                    "offset_left": 1,
                    "offset_top": 23389
                  }
                },
                {
                  "url": "https://dataforseo.com/wp-content/plugins/dataforseo-updates/assets/css/style.css?ver=5.8.1",
                  "initiator": "(index)",
                  "duration_time": 41,
                  "fetch_start": 0,
                  "fetch_end": 41,
                  "location": {
                    "line": 49,
                    "offset_left": 1,
                    "offset_top": 23210
                  }
                },
                {
                  "url": "https://dataforseo.com/wp-content/plugins/dataforseo-kb/assets/css/grid.css?ver=5.8.1",
                  "initiator": "(index)",
                  "duration_time": 43,
                  "fetch_start": 0,
                  "fetch_end": 43,
                  "location": {
                    "line": 47,
                    "offset_left": 1,
                    "offset_top": 22871
                  }
                },
                {
                  "url": "https://maps.googleapis.com/maps-api-v3/api/js/46/12a/util.js",
                  "initiator": "(index)",
                  "duration_time": 5,
                  "fetch_start": 3624,
                  "fetch_end": 3629,
                  "location": {
                    "line": 82,
                    "offset_left": 305,
                    "offset_top": null
                  }
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}

All POST data should be sent in the JSON format (UTF-8 encoding). The task setting is done using the POST method. When setting a task, you should send all task parameters in the task array of the generic POST array.

Description of the fields for setting a task:

Field name Type Description
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

‌‌‌‌‌‌
As a response of the API server, you will receive JSON-encoded data containing a tasks array with the information specific to the set tasks.

Description of the fields in the results array:

Field name Type Description
version string the current version of the API
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
time string execution time, seconds
cost float total tasks cost, USD
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 array array of tasks
        id string task identifier
unique task identifier in our system in the UUID format
        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
        status_message string informational message of the task
you can find the full list of general informational messages here
        time string execution time, seconds
        cost float cost of the task, USD
        result_count integer number of elements in the result array
        path array URL path
        data object contains the same parameters that you specified in the POST request
        result array array of results
            crawl_progress string status of the crawling session
possible values: in_progress, finished
            crawl_status object details of the crawling session
               max_crawl_pages integer maximum number of pages to crawl
indicates the max_crawl_pages limit you specified when setting a task
               pages_in_queue integer number of pages that are currently in the crawling queue
               pages_crawled integer number of crawled pages
            items_count integer number of items in the results array
            items array items array
                page_url string URL of the page
                time_to_interactive integer Time To Interactive (TTI) metric
the time it takes until the user can interact with a page (in milliseconds)
                dom_complete integer time to load resources
the time it takes until the page and all of its subresources are downloaded (in milliseconds)
                connection_time integer time to connect to a server
the time it takes until the connection with a server is established (in milliseconds)
                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)
                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)
                waiting_time integer time to first byte (TTFB) in milliseconds
                download_time integer time it takes for a browser to receive a response (in milliseconds)
                duration_time integer total time it takes until a browser receives a complete response from a server (in milliseconds)
                fetch_start integer time to start downloading the HTML resource
the amount of time the browser needs to start downloading a page
                fetch_end integer time to complete downloading the HTML resource
the amount of time the browser needs to complete downloading a page
                resources array resource-specific timing
contains separate arrays with timing for each resource found on the page
                    url string resource URL
                    initiator string resource initiator
                    duration_time integer total time it takes until a browser receives a complete response from a server (in milliseconds)
                    fetch_start integer time to start downloading the resource
the amount of time the browser needs to start downloading a resource
                    fetch_end integer time to complete downloading the resource
the amount of time the browser needs to complete downloading a resource
                    location array location of the resource in the document
parameters defining the location of the specific resource within the document’s HTML
                        line integer line number
the number of the line on which the resource is located
                        offset_left integer position in line
the number of line symbols before the resource;
sometimes referred to as column
Note: counts from 1, i.e. if the resource doesn’t have any symbols to the left, the value will be 1
                        offset_top integer position in the document
the total number of symbols between the resource and the top of HTML

‌‌