NAVNavbar
Logo
php python csharp java

Setting SimilarWeb Traffic Analytics Tasks

‌‌
SimilarWeb Traffic Analytics API provides you with website traffic and competitors data. You will receive total website visits, website traffic by countries along with its sources, site ranks, and various competitor data. This data is especially useful for running competitor analysis and market intelligence campaigns. Note that you can get data only for websites with over 5,000 monthly visitors due to SimilarWeb restrictions.

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/';
try {
	// Instead of 'login' and 'password' use your credentials from https://app.dataforseo.com/api-dashboard
	$client = new RestClient($api_url, null, 'login', 'password');
} 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";
	exit();
}
$post_array = array();
// example #1 - a simple way to set a task
$post_array[] = array(
	"target" => "dataforseo.com"
);
// example #2 - a way to set a task with additional parameters
// this way you need to specify a domain of the website in the field "target".
// after a task is completed, we will send a GET request to the address you specify. Instead of $id and $tag, you will receive actual values that are relevant to this task.
$post_array[] = array(
	"target" => "dataforseo.com",
	"tag" => "some_string_123",
	"pingback_url" => 'https://your-server.com/pingscript?id=$id&tag=$tag'
);
try {
	// POST /v3/traffic_analytics/similarweb/task_post
	$result = $client->post('/v3/traffic_analytics/similarweb/task_post', $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.20200203",
  "status_code": 20000,
  "status_message": "Ok.",
  "time": "0.1174 sec.",
  "cost": 0.2,
  "tasks_count": 2,
  "tasks_error": 0,
  "tasks": [
    {
      "id": "02051146-0696-0002-0000-8e09adb105a6",
      "status_code": 20100,
      "status_message": "Task Created.",
      "time": "0.0084 sec.",
      "cost": 0.1,
      "result_count": 0,
      "path": [
        "v3",
        "traffic_analytics",
        "similarweb",
        "task_post"
      ],
      "data": {
        "api": "traffic_analytics",
        "function": "task_post",
        "se": "similarweb",
        "target": "dataforseo.com"
      },
      "result": null
    },
    {
      "id": "02051146-0696-0002-0000-8a55d8f1c344",
      "status_code": 20100,
      "status_message": "Task Created.",
      "time": "0.0647 sec.",
      "cost": 0.1,
      "result_count": 0,
      "path": [
        "v3",
        "traffic_analytics",
        "similarweb",
        "task_post"
      ],
      "data": {
        "api": "traffic_analytics",
        "function": "task_post",
        "se": "similarweb",
        "target": "dataforseo.com",
        "tag": "some_string_123",
        "pingback_url": "https://your-server.com/pingscript?id=$id&tag=$tag"
      },
      "result": 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.

You can retrieve the results of completed tasks using the unique task identifier id. Alternatively, we can send them to you as soon as they are ready if you specify the postback_url or pingback_url when setting a task. Note that if your server doesn’t respond within 30 seconds, the connection will be aborted by timeout, and the task will be transferred to the ‘Tasks Ready’ list. The error code and message depend on your server’s configuration. Watch the video to learn more about using pingbacks and postbacks with DataForSEO APIs.

Below you will find a detailed description of the fields you can use for setting a task.

Description of the fields for setting a task:

Field name Type Description
target string website domain
required field
you need to specify the domain you want to receive results for
example:
website.com
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 array of the response
postback_url string return URL for sending task results
optional field
once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as $tag variable. We will set the necessary values before sending the request.
example:
http://your-server.com/postbackscript?id=$id
http://your-server.com/postbackscript?id=$id&tag=$tag
pingback_url string notification URL of a completed task
optional field
when a task is completed we will notify you by GET request sent to the URL you have specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as $tag variable. We will set the necessary values before sending the request.
example:
http://your-server.com/pingscript?id=$id
http://your-server.com/pingscript?id=$id&tag=$tag

‌‌‌‌‌‌
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
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 tasksarray
tasks_error integer the number of tasks in the tasks array returned with an error
tasks array array of tasks
        id string unique task identifier in our system
in the Universally Unique Identifier (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 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 array the data specified in the API call
        result array array of results
in this case, the value will be null

‌‌