Felo API PlatformFelo API Platform
v0.1.0-beta
OpenAPI 3.1.0

Domain Rank Overview

Felo API Support
MIT
伺服器:https://openapi.felo.ai
用戶端程式庫
Shell Curl

DataForSEO

​

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

DataForSEO 操作

Domain Rank Overview

​

A domain's search footprint: organic and paid keyword counts, estimated traffic and traffic value, by location_code. Returns se_type, target, 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. For the same numbers over time use post_dataforseo_labs_google_historical_rank_live; for many domains at once, post_dataforseo_labs_google_bulk_traffic_estimation_live.

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

      domain required field the domain name of the target website the domain should be specified without https:// and www.

    • ignore_synonyms
      類型: boolean

      ignore highly similar keywords optional field if set to true, all highly similar keywords will be excluded from the ranking and traffic calculations, the results will be based on data for main keywords from groups of synonyms default value: false

    • language_code
      類型: string

      language code optional field if you use this field, you don’t need to specify language_name you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages ignore this field to get the results for all available languages example: en

    • language_name
      類型: string

      full name of the language optional field if you use this field, you don’t need to specify language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages ignore this field to get the results for all available languages example: English

    • limit
      類型: integer

      the maximum number of returned results for domain optional field default value: 100 maximum value: 1000

    • location_code
      類型: integer

      location code optional field if you use this field, you don’t need to specify location_name you can receive the list of available locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages ignore this field to get the results for all available locations example: 2840

    • location_name
      類型: string

      full name of the location optional field if you use this field, you don’t need to specify location_code you can receive the list of available locations with their location_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages ignore this field to get the results for all available locations example: United Kingdom

    • offset
      類型: integer

      offset in the results array of returned items optional field default value: 0 if you specify the 10 value, the first ten items in the results array will be omitted and the data will be provided for the successive items

    • 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[]

      contains ranking and traffic data

    • tasks.result.items_count
      類型: integer

      the number of results returned in the items array

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

      language code in a POST array

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

      location code in a POST array

    • tasks.result.items.metrics
      類型: object

      ranking data relevant to the specified domain

    • tasks.result.items.metrics.organic
      類型: object

      ranking and traffic data from organic search

    • tasks.result.items.metrics.organic.count
      類型: integer

      total count of organic SERPs that contain the domain

    • tasks.result.items.metrics.organic.estimated_paid_traffic_cost
      類型: number

      estimated cost of converting organic search traffic into paid represents the estimated monthly cost of running ads (USD) for all keywords that a domain ranks for the metric is calculated as the product of organic etv and paid cpc values and indicates the cost of driving the estimated volume of monthly organic traffic through PPC advertising in Google Search learn more about how the metric is calculated in this help center article

    • tasks.result.items.metrics.organic.etv
      類型: number

      estimated traffic volume estimated organic monthly traffic to the domain calculated as the product of CTR (click-through-rate) and search volume values of all keywords the domain ranks for learn more about how the metric is calculated in this help center article

    • tasks.result.items.metrics.organic.is_down
      類型: integer

      rank went down indicates how many ranked elements of this domain went down in Google Search

    • tasks.result.items.metrics.organic.is_lost
      類型: integer

      lost ranked elements indicates how many ranked elements of this domain were previously presented in SERPs, but weren’t found during the last check

    • tasks.result.items.metrics.organic.is_new
      類型: integer

      number of new ranked elements indicates how many new ranked elements were found for this domain

    • tasks.result.items.metrics.organic.is_up
      類型: integer

      rank went up indicates how many ranked elements of this domain went up in Google Search

    • tasks.result.items.metrics.organic.pos_1
      類型: integer

      number of organic SERPs where the domain ranks #1

    • tasks.result.items.metrics.organic.pos_11_20
      類型: integer

      number of organic SERPs where the domain ranks #11-20

    • tasks.result.items.metrics.organic.pos_2_3
      類型: integer

      number of organic SERPs where the domain ranks #2-3

    • tasks.result.items.metrics.organic.pos_21_30
      類型: integer

      number of organic SERPs where the domain ranks #21-30

    • tasks.result.items.metrics.organic.pos_31_40
      類型: integer

      number of organic SERPs where the domain ranks #31-40

    • tasks.result.items.metrics.organic.pos_4_10
      類型: integer

      number of organic SERPs where the domain ranks #4-10

    • tasks.result.items.metrics.organic.pos_41_50
      類型: integer

      number of organic SERPs where the domain ranks #41-50

    • tasks.result.items.metrics.organic.pos_51_60
      類型: integer

      number of organic SERPs where the domain ranks #51-60

    • tasks.result.items.metrics.organic.pos_61_70
      類型: integer

      number of organic SERPs where the domain ranks #61-70

    • tasks.result.items.metrics.organic.pos_71_80
      類型: integer

      number of organic SERPs where the domain ranks #71-80

    • tasks.result.items.metrics.organic.pos_81_90
      類型: integer

      number of organic SERPs where the domain ranks #81-90

    • tasks.result.items.metrics.organic.pos_91_100
      類型: integer

      number of organic SERPs where the domain ranks #91-100

    • tasks.result.items.metrics.paid
      類型: object

      ranking and traffic data from paid search

    • tasks.result.items.metrics.paid.count
      類型: integer

      total count of paid SERPs that contain the domain

    • tasks.result.items.metrics.paid.estimated_paid_traffic_cost
      類型: number

      estimated cost of monthly search traffic represents the estimated cost of paid monthly traffic (USD) based on etv and cpc values learn more about how the metric is calculated in this help center article

    • tasks.result.items.metrics.paid.etv
      類型: number

      estimated traffic volume estimated paid monthly traffic to the domain calculated as the product of CTR (click-through-rate) and search volume values of all keywords the domain ranks for learn more about how the metric is calculated in this help center article

    • tasks.result.items.metrics.paid.is_down
      類型: integer

      rank went down indicates how many ranked elements of this domain went down in Google Search

    • tasks.result.items.metrics.paid.is_lost
      類型: integer

      lost ranked elements indicates how many ranked elements of this domain were previously presented in SERPs, but weren’t found during the last check

    • tasks.result.items.metrics.paid.is_new
      類型: integer

      number of new ranked elements indicates how many new ranked elements were found for this domain

    • tasks.result.items.metrics.paid.is_up
      類型: integer

      rank went up indicates how many ranked elements of this domain went up in Google Search

    • tasks.result.items.metrics.paid.pos_1
      類型: integer

      number of paid SERPs where the domain ranks #1

    • tasks.result.items.metrics.paid.pos_11_20
      類型: integer

      number of paid SERPs where the domain ranks #11-20

    • tasks.result.items.metrics.paid.pos_2_3
      類型: integer

      number of paid SERPs where the domain ranks #2-3

    • tasks.result.items.metrics.paid.pos_21_30
      類型: integer

      number of paid SERPs where the domain ranks #21-30

    • tasks.result.items.metrics.paid.pos_31_40
      類型: integer

      number of paid SERPs where the domain ranks #31-40

    • tasks.result.items.metrics.paid.pos_4_10
      類型: integer

      number of paid SERPs where the domain ranks #4-10

    • tasks.result.items.metrics.paid.pos_41_50
      類型: integer

      number of paid SERPs where the domain ranks #41-50

    • tasks.result.items.metrics.paid.pos_51_60
      類型: integer

      number of paid SERPs where the domain ranks #51-60

    • tasks.result.items.metrics.paid.pos_61_70
      類型: integer

      number of paid SERPs where the domain ranks #61-70

    • tasks.result.items.metrics.paid.pos_71_80
      類型: integer

      number of paid SERPs where the domain ranks #71-80

    • tasks.result.items.metrics.paid.pos_81_90
      類型: integer

      number of paid SERPs where the domain ranks #81-90

    • tasks.result.items.metrics.paid.pos_91_100
      類型: integer

      number of paid SERPs where the domain ranks #91-100

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

      search engine type

    • tasks.result.language_code
      類型: string

      language code in a POST array

    • tasks.result.location_code
      類型: integer

      location code in a POST array

    • tasks.result.se_type
      類型: string

      search engine type

    • tasks.result.target
      類型: string

      target domain in a POST array

    • tasks.result.total_count
      類型: integer

      total amount of results in our database relevant to your request

    • 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/dataforseo_labs/google/domain_rank_overview/live
curl https://openapi.felo.ai/v1/beta/dataforseo/dataforseo_labs/google/domain_rank_overview/live \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '[
  {
    "target": "",
    "location_name": "",
    "location_code": 1,
    "language_name": "",
    "language_code": "",
    "ignore_synonyms": true,
    "limit": 1,
    "offset": 1,
    "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.se_type": "string",
  "tasks.result.target": "string",
  "tasks.result.location_code": 1,
  "tasks.result.language_code": "string",
  "tasks.result.total_count": 1,
  "tasks.result.items_count": 1,
  "tasks.result.items": [
    "string"
  ],
  "tasks.result.items.se_type": "string",
  "tasks.result.items.location_code": 1,
  "tasks.result.items.language_code": "string",
  "tasks.result.items.metrics": {},
  "tasks.result.items.metrics.organic": {},
  "tasks.result.items.metrics.organic.pos_1": 1,
  "tasks.result.items.metrics.organic.pos_2_3": 1,
  "tasks.result.items.metrics.organic.pos_4_10": 1,
  "tasks.result.items.metrics.organic.pos_11_20": 1,
  "tasks.result.items.metrics.organic.pos_21_30": 1,
  "tasks.result.items.metrics.organic.pos_31_40": 1,
  "tasks.result.items.metrics.organic.pos_41_50": 1,
  "tasks.result.items.metrics.organic.pos_51_60": 1,
  "tasks.result.items.metrics.organic.pos_61_70": 1,
  "tasks.result.items.metrics.organic.pos_71_80": 1,
  "tasks.result.items.metrics.organic.pos_81_90": 1,
  "tasks.result.items.metrics.organic.pos_91_100": 1,
  "tasks.result.items.metrics.organic.etv": 1,
  "tasks.result.items.metrics.organic.count": 1,
  "tasks.result.items.metrics.organic.estimated_paid_traffic_cost": 1,
  "tasks.result.items.metrics.organic.is_new": 1,
  "tasks.result.items.metrics.organic.is_up": 1,
  "tasks.result.items.metrics.organic.is_down": 1,
  "tasks.result.items.metrics.organic.is_lost": 1,
  "tasks.result.items.metrics.paid": {},
  "tasks.result.items.metrics.paid.pos_1": 1,
  "tasks.result.items.metrics.paid.pos_2_3": 1,
  "tasks.result.items.metrics.paid.pos_4_10": 1,
  "tasks.result.items.metrics.paid.pos_11_20": 1,
  "tasks.result.items.metrics.paid.pos_21_30": 1,
  "tasks.result.items.metrics.paid.pos_31_40": 1,
  "tasks.result.items.metrics.paid.pos_41_50": 1,
  "tasks.result.items.metrics.paid.pos_51_60": 1,
  "tasks.result.items.metrics.paid.pos_61_70": 1,
  "tasks.result.items.metrics.paid.pos_71_80": 1,
  "tasks.result.items.metrics.paid.pos_81_90": 1,
  "tasks.result.items.metrics.paid.pos_91_100": 1,
  "tasks.result.items.metrics.paid.etv": 1,
  "tasks.result.items.metrics.paid.count": 1,
  "tasks.result.items.metrics.paid.estimated_paid_traffic_cost": 1,
  "tasks.result.items.metrics.paid.is_new": 1,
  "tasks.result.items.metrics.paid.is_up": 1,
  "tasks.result.items.metrics.paid.is_down": 1,
  "tasks.result.items.metrics.paid.is_lost": 1
}

Successful response

Domain Rank Overview