Felo API PlatformFelo API Platform
v0.1.0-beta
OpenAPI 3.1.0
伺服器:https://openapi.felo.ai
用戶端程式庫

DataForSEO

​

SEO, search-engine results, keyword research, backlinks and AI visibility data.

Competitors

​

Sites sharing referring domains with one target, ranked by how many they share. Each row gives target, rank and intersections - the count of shared linking domains. main_domain, exclude_large_domains and exclude_internal_backlinks shape what counts. These are link-graph competitors, not search competitors; for the latter use post_dataforseo_labs_google_serp_competitors_live. To see the actual shared domains use post_dataforseo_backlinks_domain_intersection_live.

請求本文
必填
application/json
  • 類型: array object[]
    • target
      類型: string
      必填

      domain, subdomain or webpage to get competitor domains for required field a domain or a subdomain should be specified without https:// and www. a page should be specified with absolute URL (including http:// or https://)

    • exclude_internal_backlinks
      類型: boolean

      indicates if internal backlinks from subdomains to the target will be excluded from the results optional field if set to true, the results will not include data on internal backlinks from subdomains of the same domain as target if set to false, internal links will be included in the results default value: true

    • exclude_large_domains
      類型: boolean

      indicates whether large domain will appear in results optional field if set to true, the results from the large domain (google.com, amazon.com, etc.) will be omitted; default value: true

    • 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, like, not_like, ilike, not_ilike, match, not_match you can use the % operator with like and not_like to match any string of zero or more characters example: ["rank",">","100"] [["target","like","%forbes%"], "and", [["rank",">","100"],"or",["intersections",">","5"]]] The full list of possible filters is available here.

    • limit
      類型: integer

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

    • main_domain
      類型: boolean

      indicates if only main domain of the target will be included in the search optional field if set to true, only the main domain will be included in search; default value: true

    • 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 pages

    • order_by
      類型: array string[]

      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 you should use a comma to set up a sorting type example: ["rank,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: ["intersections,desc","rank,asc"]

    • rank_scale
      類型: string

      defines the scale used for calculating and displaying the rank, domain_from_rank, and page_from_rank values optional field you can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scale possible values: one_hundred — rank values are displayed on a 0–100 scale one_thousand — rank values are displayed on a 0–1000 scale default value: one_thousand learn more about how this parameter works and how ranking metrics are calculated in this Help Center article

    • 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

回應
  • 200
    類型: object

    Successful response

    • cost
      類型: number

      total tasks cost, USD

    • 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

    • tasks
      類型: array string[]

      array of tasks

    • 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.cost
      類型: number

      cost of the task, USD

    • tasks.data
      類型: object

      contains the same parameters that you specified in the POST request

    • tasks.id
      類型: string

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

    • tasks.path
      類型: array string[]

      URL path

    • tasks.result
      類型: array string[]

      array of results

    • tasks.result_count
      類型: integer

      number of elements in the result array

    • tasks.result.items
      類型: array string[]

      items array

    • tasks.result.items_count
      類型: integer

      number of items in the items array

    • tasks.result.items.intersections
      類型: integer

      indicates the number of backlink intersections with the target specified in the POST array

    • tasks.result.items.rank
      類型: integer

      domain rank domain rank across all domains in the database rank is calculated based on the method for node ranking in a linked database – a principle used in the original Google PageRank algorithm learn more about the metric and how it is calculated in this help center article

    • tasks.result.items.target
      類型: string

      competitor domain

    • tasks.result.items.type
      類型: string

      type of element = ‘backlinks_competitors’

    • tasks.result.total_count
      類型: integer

      total number of relevant items in the database

    • tasks.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

    • tasks.status_message
      類型: string

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

    • tasks.time
      類型: string

      execution time, seconds

    • time
      類型: string

      execution time, seconds

    • version
      類型: string

      the current version of the API

    application/json
  • 400

    Bad request

  • 401

    Unauthorized

  • 402

    The request cannot proceed because a billing requirement is not met.

  • 403

    The account is not permitted to perform this operation.

  • 429

    Rate limit exceeded

  • 500

    Internal server error

  • 502

    The service could not complete the request.

  • 503

    The API or billing service is temporarily unavailable.

  • 504

    The service timed out while processing the request.

  • default

    The operation failed. Keep the response request ID when contacting Felo support.

Request Example for post/v1/beta/dataforseo/backlinks/competitors/live
curl https://openapi.felo.ai/v1/beta/dataforseo/backlinks/competitors/live \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '[
  {
    "target": "",
    "limit": 1,
    "offset": 1,
    "filters": [],
    "order_by": [
      ""
    ],
    "main_domain": true,
    "exclude_large_domains": true,
    "exclude_internal_backlinks": true,
    "rank_scale": "",
    "tag": ""
  }
]'
{
  "version": "string",
  "status_code": 1,
  "status_message": "string",
  "time": "string",
  "cost": 1,
  "tasks_count": 1,
  "tasks_error": 1,
  "tasks": [
    "string"
  ],
  "tasks.id": "string",
  "tasks.status_code": 1,
  "tasks.status_message": "string",
  "tasks.time": "string",
  "tasks.cost": 1,
  "tasks.result_count": 1,
  "tasks.path": [
    "string"
  ],
  "tasks.data": {},
  "tasks.result": [
    "string"
  ],
  "tasks.result.total_count": 1,
  "tasks.result.items_count": 1,
  "tasks.result.items": [
    "string"
  ],
  "tasks.result.items.type": "string",
  "tasks.result.items.target": "string",
  "tasks.result.items.rank": 1,
  "tasks.result.items.intersections": 1
}
Competitors