dataforseo_labs/bing/serp_competitors/live

SERP Competitors

‌
This endpoint will provide you with a list of domain rankings for the keywords you specify. You will also get SERP rankings, rating, estimated traffic volume, and visibility values the provided domains gain from the specified keywords.

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

            
# Instead of 'login' and 'password' use your credentials from https://app.dataforseo.com/api-access 
login="login" 
password="password" 
cred="$(printf ${login}:${password} | base64)" 
curl --location --request POST "https://api.dataforseo.com/v3/dataforseo_labs/bing/serp_competitors/live" 
--header "Authorization: Basic ${cred}"  
--header "Content-Type: application/json" 
--data-raw "[
    {
        "keywords": [
            "phone"
        ],
        "language_name": "English",
        "location_code": 2840,
        "item_types" : ["organic"],
        "limit":5
    }
]"


<?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-access
$client = new RestClient($api_url, null, 'login', 'password');

$post_array = array();
// simple way to set a task
$post_array[] = array(
	"keywords" => [
		"phone",
		"watch"
	],
	"language_name" => "English",
	"location_code" => 2840,
	"filters" => [
		["relevant_serp_items", ">", 0],
		"or",
		["median_position", "in", [ 1, 10 ]]
	]
);
try {
   // POST /v3/dataforseo_labs/bing/serp_competitors/live
   $result = $client->post('/v3/dataforseo_labs/bing/serp_competitors/live', $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;
?>

            
from client import RestClient
# You can download this file from here https://cdn.dataforseo.com/v3/examples/python/python_Client.zip
client = RestClient("login", "password")
post_data = dict()
# simple way to set a task
post_data[len(post_data)] = dict(
    keywords=[
        "phone",
        "watch"
    ],
    location_name="United States",
    language_name="English",
    filters=[
        ["relevant_serp_items", ">", 0],
        "or",
        ["median_position", "in", [ 1, 10 ]]
    ]
)
# POST /v3/dataforseo_labs/bing/serp_competitors/live
response = client.post("/v3/dataforseo_labs/bing/serp_competitors/live", post_data)
# you can find the full list of the response codes here https://docs.dataforseo.com/v3/appendix/errors
if response["status_code"] == 20000:
    print(response)
    # do something with result
else:
    print("error. Code: %d Message: %s" % (response["status_code"], response["status_message"]))

            

const post_array = [];

post_array.push({
  "keywords": [
    "phone",
    "watch"
  ],
  "language_name": "English",
  "location_code": 2840,
  "filters": [
    ["relevant_serp_items", ">", 0],
    "or",
    ["median_position", "in", [1, 10]]
  ]
});

const axios = require('axios');

axios({
  method: 'post',
  url: 'https://api.dataforseo.com/v3/dataforseo_labs/bing/serp_competitors/live',
  auth: {
    username: 'login',
    password: 'password'
  },
  data: post_array,
  headers: {
    'content-type': 'application/json'
  }
}).then(function (response) {
  var result = response['data']['tasks'];
  // Result data
  console.log(result);
}).catch(function (error) {
  console.log(error);
});

            
using Newtonsoft.Json;
using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;

namespace DataForSeoDemos
{
    public static partial class Demos
    {
        public static async Task dataforseo_labs_bing_serp_competitors_live()
        {
            var httpClient = new HttpClient
            {
                BaseAddress = new Uri("https://api.dataforseo.com/"),
                // Instead of 'login' and 'password' use your credentials from https://app.dataforseo.com/api-access
                DefaultRequestHeaders = { Authorization = new AuthenticationHeaderValue("Basic", Convert.ToBase64String(Encoding.ASCII.GetBytes("login:password"))) }
            };
            var postData = new List<object>();
            postData.Add(new
            {
                keywords = new[]
                {
                    "phone",
                    "watch"
                },
                location_name = "United States",
                language_name = "English",
                filters = new object[]
                {
                    new object[] { "relevant_serp_items", ">", 0 },
                    "or",
                    new object[] { "median_position", "in", new object[] { 1, 10 } }
                }
            });
            // POST /v3/dataforseo_labs/bing/serp_competitors/live
            // the full list of possible parameters is available in documentation
            var taskPostResponse = await httpClient.PostAsync("/v3/dataforseo_labs/bing/serp_competitors/live", new StringContent(JsonConvert.SerializeObject(postData)));
            var result = JsonConvert.DeserializeObject(await taskPostResponse.Content.ReadAsStringAsync());
            // you can find the full list of the response codes here https://docs.dataforseo.com/v3/appendix/errors
            if (result.status_code == 20000)
            {
                // do something with result
                Console.WriteLine(result);
            }
            else
                Console.WriteLine($"error. Code: {result.status_code} Message: {result.status_message}");
        }
    }
}

The above command returns JSON structured like this:

{
  "version": "0.1.20220216",
  "status_code": 20000,
  "status_message": "Ok.",
  "time": "0.1093 sec.",
  "cost": 0.0113,
  "tasks_count": 1,
  "tasks_error": 0,
  "tasks": [
    {
      "id": "03151520-1535-0383-0000-39bcba7b8684",
      "status_code": 20000,
      "status_message": "Ok.",
      "time": "0.0632 sec.",
      "cost": 0.0113,
      "result_count": 1,
      "path": [
        "v3",
        "dataforseo_labs",
        "bing",
        "serp_competitors",
        "live"
      ],
      "data": {
        "api": "dataforseo_labs",
        "function": "serp_competitors",
        "se_type": "bing",
        "keywords": [
          "phone",
          "watch"
        ],
        "language_name": "English",
        "location_code": 2840,
        "filters": [
          [
            "relevant_serp_items",
            ">",
            0
          ],
          "or",
          [
            "median_position",
            "in",
            [
              1,
              10
            ]
          ]
        ]
      },
      "result": [
        {
          "se_type": "bing",
          "seed_keywords": [
            "phone",
            "watch"
          ],
          "location_code": 2840,
          "language_code": "en",
          "total_count": 13,
          "items_count": 13,
          "items": [
            {
              "se_type": "bing",
              "domain": "www.amazon.com",
              "avg_position": 3,
              "median_position": 2,
              "rating": 194,
              "etv": 12565.555,
              "keywords_count": 2,
              "visibility": 1.6,
              "relevant_serp_items": 2,
              "keywords_positions": {
                "phone": [
                  4
                ],
                "watch": [
                  2
                ]
              }
            },
            {
              "se_type": "bing",
              "domain": "play.google.com",
              "avg_position": 1,
              "median_position": 1,
              "rating": 99,
              "etv": 16796,
              "keywords_count": 1,
              "visibility": 1,
              "relevant_serp_items": 1,
              "keywords_positions": {
                "phone": [
                  1
                ]
              }
            },
            {
              "se_type": "bing",
              "domain": "www.apple.com",
              "avg_position": 1,
              "median_position": 1,
              "rating": 99,
              "etv": 16747.36,
              "keywords_count": 1,
              "visibility": 1,
              "relevant_serp_items": 1,
              "keywords_positions": {
                "watch": [
                  1
                ]
              }
            },
            {
              "se_type": "bing",
              "domain": "www.bestbuy.com",
              "avg_position": 2,
              "median_position": 2,
              "rating": 98,
              "etv": 8950.5,
              "keywords_count": 1,
              "visibility": 0.9,
              "relevant_serp_items": 1,
              "keywords_positions": {
                "phone": [
                  2
                ]
              }
            },
            {
              "se_type": "bing",
              "domain": "www.merriam-webster.com",
              "avg_position": 3,
              "median_position": 3,
              "rating": 97,
              "etv": 5360.257,
              "keywords_count": 1,
              "visibility": 0.8,
              "relevant_serp_items": 1,
              "keywords_positions": {
                "watch": [
                  3
                ]
              }
            },
            {
              "se_type": "bing",
              "domain": "www.thefreedictionary.com",
              "avg_position": 4,
              "median_position": 4,
              "rating": 96,
              "etv": 3630.431,
              "keywords_count": 1,
              "visibility": 0.7,
              "relevant_serp_items": 1,
              "keywords_positions": {
                "watch": [
                  4
                ]
              }
            },
            {
              "se_type": "bing",
              "domain": "www.worldofwatches.com",
              "avg_position": 5,
              "median_position": 5,
              "rating": 95,
              "etv": 2583.721,
              "keywords_count": 1,
              "visibility": 0.6,
              "relevant_serp_items": 1,
              "keywords_positions": {
                "watch": [
                  5
                ]
              }
            },
            {
              "se_type": "bing",
              "domain": "www.whitepages.com",
              "avg_position": 6,
              "median_position": 6,
              "rating": 94,
              "etv": 1867.4499999999998,
              "keywords_count": 1,
              "visibility": 0.5,
              "relevant_serp_items": 1,
              "keywords_positions": {
                "phone": [
                  6
                ]
              }
            },
            {
              "se_type": "bing",
              "domain": "www.watches.com",
              "avg_position": 6,
              "median_position": 6,
              "rating": 94,
              "etv": 1862.042,
              "keywords_count": 1,
              "visibility": 0.5,
              "relevant_serp_items": 1,
              "keywords_positions": {
                "watch": [
                  6
                ]
              }
            },
            {
              "se_type": "bing",
              "domain": "www.usu.edu",
              "avg_position": 7,
              "median_position": 7,
              "rating": 93,
              "etv": 1414.4,
              "keywords_count": 1,
              "visibility": 0.4,
              "relevant_serp_items": 1,
              "keywords_positions": {
                "phone": [
                  7
                ]
              }
            },
            {
              "se_type": "bing",
              "domain": "www.netflix.com",
              "avg_position": 7,
              "median_position": 7,
              "rating": 93,
              "etv": 1410.304,
              "keywords_count": 1,
              "visibility": 0.4,
              "relevant_serp_items": 1,
              "keywords_positions": {
                "watch": [
                  7
                ]
              }
            },
            {
              "se_type": "bing",
              "domain": "www.murray.utah.gov",
              "avg_position": 8,
              "median_position": 8,
              "rating": 92,
              "etv": 1088.425,
              "keywords_count": 1,
              "visibility": 0.3,
              "relevant_serp_items": 1,
              "keywords_positions": {
                "phone": [
                  8
                ]
              }
            },
            {
              "se_type": "bing",
              "domain": "www.plgrove.org",
              "avg_position": 9,
              "median_position": 9,
              "rating": 91,
              "etv": 828.75,
              "keywords_count": 1,
              "visibility": 0.2,
              "relevant_serp_items": 1,
              "keywords_positions": {
                "phone": [
                  9
                ]
              }
            }
          ]
        }
      ]
    }
  ]
}

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 send up to 2000 API calls per minute. The maximum number of requests that can be sent simultaneously is limited to 30.

You can specify the number of results you want to retrieve, filter and sort them.

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
`keywords`	array	keywords array required field the results will be based on the keywords you specify in this array UTF-8 encoding; the keywords will be converted to lowercase format; you can specify the maximum of 200 keywords learn more about rules and limitations of `keyword` and `keywords` fields in DataForSEO APIs in this Help Center article
`location_name`	string	full name of the location required field if you don’t specify `location_code` Note: it is required to specify either `location_name` or `location_code` you can receive the list of available locations with `location_name` parameters by making a separate request to `https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages`; Note: this endpoint currently supports the US location only; example: `United States`
`location_code`	integer	unique location identifier required field if you don’t specify `location_name` Note: it is required to specify either `location_name` or `location_code` you can receive the list of available locations with their `location_code` parameters by making a separate request to `https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages`; Note: this endpoint currently supports the US location only; example: `2840`
`language_name`	string	full name of the language required field if you don’t specify `language_code` Note: it is required to specify either `language_name` or `language_code` you can receive the list of available languages with their `language_name` parameters by making a separate request to the `https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages` example: `English`
`language_code`	string	unique language identifier required field if you don’t specify `language_name` Note: it is required to specify either `language_name` or `language_code` you can receive the list of available languages with their `language_code` parameters by making a separate request to the `https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages` example: `en`
`include_subdomains`	boolean	indicates if the subdomains will be included in the search optional field if set to `false`, the subdomains will be ignored default value: `true`
`item_types`	array	search results type indicates type of search results included in the response optional field possible values: `["organic", "paid", "featured_snippet", "local_pack"]` default value: `["organic", "paid", "featured_snippet", "local_pack"]`
`limit`	integer	the maximum number of returned domains optional field default value: `100` maximum value: `1000`
`offset`	integer	offset in the results array of returned domains optional field default value: `0` if you specify the `10` value, the first ten domains in the results array will be omitted and the data will be provided for the successive domains
`filters`	array	array of results filtering parameters optional field you can add several filters at once (8 filters maximum) you should set a logical operator `and`, `or` between the conditions the following operators are supported: `regex`, `not_regex`, `<`, `<=`, `>`, `>=`, `=`, `<>`, `in`, `not_in`, `ilike`, `not_ilike`, `like`, `not_like` you can use the `%` operator with `like` and `not_like`, as well as `ilike` and `not_ilike` to match any string of zero or more characters example: `["median_position","in",[1,10]]` `[["median_position","in",[1,10]],"and",["domain","not_like","%wikipedia.org%"]]` `[["domain","not_like","%wikipedia.org%"], "and", [["relevant_serp_items",">",0],"or",["median_position","in",[1,10]]]]` for more information about filters, please refer to Dataforseo Labs – Filters or this help center guide
`order_by`	array	results sorting rules optional field you can use the same values as in the `filters` array to sort the results possible sorting types: `asc` – results will be sorted in the ascending order `desc` – results will be sorted in the descending order the comma is used as a separator example: `["avg_position,asc"]` default rule: `["rating,desc"]` note that you can set no more than three sorting rules in a single request you should use a comma to separate several sorting rules example: `["avg_position,asc","etv,desc"]`
`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
`se_type`	string	search engine type
`seed_keywords`	array	keywords specified in the request keyword is returned with decoded %## (plus character ‘+’ will be decoded to a space character)
`location_code`	integer	location code in a POST array if there is no data, then the value is `null`
`language_code`	string	language code in a POST array if there is no data, then the value is `null`
`total_count`	integer	the total amount of results in our database relevant to your request
`items_count`	integer	the number of results returned in the `items` array
`items`	array	contains detected SERP competitors and related data
`se_type`	string	search engine type
`domain`	string	domain name of the detected SERP competitor
`avg_position`	integer	the average position of the domain for the specified keywords the arithmetic mean of values in the `keywords_positions` array
`median_position`	integer	the median position of the domain for the specified keywords the median of the values in the `keywords_positions` array
`rating`	integer	the margin between the greatest possible and actual keyword positions represents the relative visibility rate of the domain in SERP for the specified keywords calculated as sum(100-`keywords_positions`)
`etv`	float	estimated traffic volume represents the estimated monthly traffic that specified keywords are driving to the website calculated as the sum of the products of the specified keywords’ search volume values and CTR (click-through-rate) rates at certain positions in SERP learn more about how the metric is calculated in this help center article
`keywords_count`	integer	the number of specified keywords the domain has positions for in SERPs
`visibility`	float	SERP visibility rate represents the website visibility rate based on the SERP positions of the specified keywords Keywords with positions in the range from 1 to 10 are assigned the visibility index from 1 to 0.1, respectively Keywords with positions in the range from 11 to 20 have the fixed visibility index of 0.05 keywords with positions from 20 to 100 have the visibility index equal to 0
`relevant_serp_items`	integer	the number of SERP elements relevant to the domain represents the number of search results in SERP relevant to the domain for the specified keywords
`keywords_positions`	object	keyword positions SERP positions the related domain holds in SERP for the specified keywords

‌‌