Felo API PlatformFelo API Platform

数据 API / DataForSEO / DataForSEO Labs

SERP Competitors

The domains ranking alongside you for a set of keywords, with how many they share. Returns se_type, seed_keywords, total_count, items_count and items. Wrapped in DataForSEO's envelope: data in tasks[0].result, outcome in tasks[0].status_code - a rejected request still returns HTTP 200. ⚠️ These are search competitors, decided by shared rankings. The link-graph equivalent is post_dataforseo_backlinks_competitors_live, and the two lists often disagree - which is itself informative.

参数

没有路径、查询或请求头参数。

请求体

  • keywordsstring[]必填

    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_namestring可选

    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 the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: United Kingdom

  • location_codeinteger可选

    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 the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: 2840

  • language_namestring可选

    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_codestring可选

    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_subdomainsboolean可选

    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_typesstring[]可选

    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"]

  • limitinteger可选

    the maximum number of returned domains optional field default value: 100 maximum value: 1000

  • offsetinteger可选

    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

  • filtersarray可选

    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, match, not_match, 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_bystring[]可选

    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"]

  • tagstring可选

    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

请求示例

curl -X POST "https://openapi.felo.ai/v1/beta/dataforseo/dataforseo_labs/google/serp_competitors/live" \
  -H "Authorization: Bearer $FELO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "keywords": [
    "<string>"
  ],
  "location_name": "<string>",
  "location_code": 0,
  "language_name": "<string>",
  "language_code": "<string>",
  "include_subdomains": false,
  "item_types": [
    "<string>"
  ],
  "limit": 0
}'

响应

响应字段

  • versionstring可选

    the current version of the API

  • status_codeinteger可选

    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_messagestring可选

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

  • timestring可选

    execution time, seconds

  • costnumber可选

    total tasks cost, USD

  • tasks_countinteger可选

    the number of tasks in the tasks array

  • tasks_errorinteger可选

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

  • tasksstring[]可选

    array of tasks

  • idstring可选

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

  • status_codeinteger可选

    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_messagestring可选

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

  • timestring可选

    execution time, seconds

  • costnumber可选

    cost of the task, USD

  • result_countinteger可选

    number of elements in the result array

  • pathstring[]可选

    URL path

  • dataobject可选

    contains the same parameters that you specified in the POST request

  • resultstring[]可选

    array of results

  • se_typestring可选

    search engine type

  • seed_keywordsstring[]可选

    keywords specified in the request keyword is returned with decoded %## (plus character ‘+’ will be decoded to a space character)

  • location_codeinteger可选

    location code in a POST array if there is no data, then the value is null

  • language_codestring可选

    language code in a POST array if there is no data, then the value is null

  • total_countinteger可选

    the total amount of results in our database relevant to your request

  • items_countinteger可选

    the number of results returned in the items array

  • itemsstring[]可选

    contains detected SERP competitors and related data

  • se_typestring可选

    search engine type

  • domainstring可选

    domain name of the detected SERP competitor

  • avg_positioninteger可选

    the average position of the domain for the specified keywords the arithmetic mean of values in the keywords_positions array

  • median_positioninteger可选

    the median position of the domain for the specified keywords the median of the values in the keywords_positions array

  • ratinginteger可选

    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)

  • etvnumber可选

    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_countinteger可选

    the number of specified keywords the domain has positions for in SERPs

  • visibilitynumber可选

    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_itemsinteger可选

    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_positionsobject可选

    keyword positions SERP positions the related domain holds in SERP for the specified keywords