NAVNavbar
Logo
cURL php NodeJS Python cSharp

Redirect Сhains

‌‌
Redirect chains occur when there are at least two redirects between the initial URL and the destination URL. For example, if page A redirects to page B which redirects to page C, such a series of redirects is considered a redirect chain. Sometimes, if page B redirects back to page A, the redirect chain becomes closed and is considered a redirect loop.

This endpoint will provide you with a full list of redirect URLs that form redirect chains. Using the Redirect Сhains endpoint, you’ll be able to quickly identify and trace down multiple redirects issues.

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" => "03051327-4536-0216-1000-3b458a2cfcca",
   "url" => "https://test_rdr.dataforseo.com/a/"
);
try {
   // POST /v3/on_page/redirect_chains
   // the full list of possible parameters is available in documentation
   $result = $client->post('/v3/on_page/redirect_chains', $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.20210622",
  "status_code": 20000,
  "status_message": "Ok.",
  "time": "2.9408 sec.",
  "cost": 0,
  "tasks_count": 1,
  "tasks_error": 0,
  "tasks": [
    {
      "id": "07061451-2692-0216-1000-33d5e1cf58cd",
      "status_code": 20000,
      "status_message": "Ok.",
      "time": "2.8536 sec.",
      "cost": 0,
      "result_count": 1,
      "path": [
        "v3",
        "on_page",
        "redirect_chains"
      ],
      "data": {
        "api": "on_page",
        "function": "redirect_chains",
        "url": "https://test_rdr.dataforseo.com/a/"
      },
      "result": [
        {
          "crawl_progress": "finished",
          "crawl_status": {
            "max_crawl_pages": 5,
            "pages_in_queue": 0,
            "pages_crawled": 5
          },
          "total_items_count": 1,
          "items_count": 1,
          "items": [
            {
              "is_redirect_loop": false,
              "chain": [
                {
                  "type": "redirect",
                  "domain_from": "test_rdr.dataforseo.com",
                  "domain_to": "test_rdr.dataforseo.com",
                  "page_from": "/a/",
                  "page_to": "/b/",
                  "link_from": "https://test_rdr.dataforseo.com/a/",
                  "link_to": "https://test_rdr.dataforseo.com/b/",
                  "dofollow": true,
                  "page_from_scheme": "https",
                  "page_to_scheme": "https",
                  "direction": "internal",
                  "is_broken": false,
                  "is_link_relation_conflict": false
                },
                {
                  "type": "redirect",
                  "domain_from": "test_rdr.dataforseo.com",
                  "domain_to": "test_rdr.dataforseo.com",
                  "page_from": "/b/",
                  "page_to": "/c/",
                  "link_from": "https://test_rdr.dataforseo.com/b/",
                  "link_to": "https://test_rdr.dataforseo.com/c/",
                  "dofollow": true,
                  "page_from_scheme": "https",
                  "page_to_scheme": "https",
                  "direction": "internal",
                  "is_broken": false,
                  "is_link_relation_conflict": false
                },
                {
                  "type": "redirect",
                  "domain_from": "test_rdr.dataforseo.com",
                  "domain_to": "test_rdr.dataforseo.com",
                  "page_from": "/c/",
                  "page_to": "/test_chain.html",
                  "link_from": "https://test_rdr.dataforseo.com/c/",
                  "link_to": "https://test_rdr.dataforseo.com/test_chain.html",
                  "dofollow": true,
                  "page_from_scheme": "https",
                  "page_to_scheme": "https",
                  "direction": "internal",
                  "is_broken": false,
                  "is_link_relation_conflict": false
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}

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
optional field
absolute URL of the target page
if you use this field, the API response will return only redirect chains which contain the specified URL
limit integer the maximum number of returned redirect chains
optional field
default value: 100
maximum value: 1000
offset integer offset in the results array of returned redirect chains
optional field
default value: 0
if you specify the 10 value, the first ten redirect chains in the results array will be omitted and the data will be provided for the successive redirect chains
filters array array of results filtering parameters
optional field
you can use only one filtering parameter with this endpoint

the following filtering parameter is supported:
is_redirect_loop
the following operators are supported:
=, <>

examples:
["is_redirect_loop","=","true"]

["is_redirect_loop","<>","false"]

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
            total_items_count integer total number of relevant items in the database
            items_count integer number of items in the results array
            items array items array
                    is_redirect_loop bool indicates if redirects in chain start and end at the same URL
if true, the last URL from the chain redirects back to the original URL
                    chain array contains links that form a chain
                         type string type of the link = ‘redirect’
HTTP redirect with 3xx status code
                         domain_from string referring domain
the link was found on this domain
                         domain_to string referenced domain
the link is pointing to this domain
                         page_from string referring page
relative URL of the page on which the link was found
                         page_to string referenced page
relative URL of the page to which the link is pointing
                         link_from string referring page
absolute URL of the page on which the link was found
                         link_to string referenced page
absolute URL of the page to which the link is pointing
                         dofollow boolean indicates whether the link is dofollow
if the value is true, the link doesn’t have a rel="nofollow" attribute
                         page_from_scheme string url scheme of the referring page
                         page_to_scheme string url scheme of the referenced page
                         direction string direction of the link
possible values: internal, external
                         is_broken boolean link is broken
indicates whether a link is directing to a broken page or resource
                         is_link_relation_conflict boolean indicates that the link may have a conflict with another link
if true, at least one link pointing to the URL in link_to has a rel="nofollow" attribute and at least one is dofollow

‌‌